Skip to content
This repository was archived by the owner on Mar 7, 2019. It is now read-only.

handle deprecated/versionadded tags#30

Open
biasmv wants to merge 2 commits intobronto:masterfrom
biasmv:master
Open

handle deprecated/versionadded tags#30
biasmv wants to merge 2 commits intobronto:masterfrom
biasmv:master

Conversation

@biasmv
Copy link

@biasmv biasmv commented Sep 23, 2014

Translate @SInCE to Sphinx's '.. versionadded::' directive. Likewise,
translate @deprecated to '.. deprecated::' directive. The former is
trivial and can be translated 1:1. The latter requires some trickery
as the Spinx deprecated directive requires a mandatory version
argument which somehow has to be extracted from @deprecated.

For now, we just look at he first word of the @deprecated text and
check if it matches the format of a "version number". If it does, we
use it. If it doesn't, fallback to a hand-written deprecated
statement.

Translate @SInCE to Sphinx's '.. versionadded::' directive. Likewise,
translate @deprecated to '.. deprecated::' directive. The former is
trivial and can be translated 1:1. The latter requires some trickery
as the Spinx deprecated directive requires a mandatory version
argument which somehow has to be extracted from @deprecated.

For now, we just look at he first word of the @deprecated text and
check if it matches the format of a "version number". If it does, we
use it. If it doesn't, fallback to a hand-written deprecated
statement.
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant