Support Sphinx inline parameter syntax. #33
Merged
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
Sphinx allows types of parameters to be specified in the :param tag without a separate :type line, such as ":param int a: desc", which results in a more compact docstring. This change adds support by extending the docstring parser to parse these lines. Various test cases are included. Note: My IDE removed a couple of trailing whitespaces in the edited files.
|
Documentation on the Sphinx syntax for parameter types: http://sphinx-doc.org/domains.html#info-field-lists. |
|
Thanks! I don't have time to review this, but merging in master for the time being. |
AndreaCensi
added a commit
that referenced
this pull request
Feb 7, 2015
Support Sphinx inline parameter syntax. (Dennis Kempin, Google)
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Sphinx allows types of parameters to be specified in the :param tag without
a separate :type line, such as ":param int a: desc", which results in a more
compact docstring.
This change adds support by extending the docstring parser to parse these lines.
Various test cases are included.
Note: My IDE removed a couple of trailing whitespaces in the edited files.