This repository has been archived by the owner on Mar 7, 2019. It is now read-only.
handle deprecated/versionadded tags #30
Open
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
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.