DOC: clean-up docstrings of option functions #7236
Merged
Conversation
This file contains hidden or 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
| if o: | ||
| s += u('[default: %s] [currently: %s]') % (o.defval, | ||
| _get_option(k, True)) | ||
|
|
||
| if o.doc: | ||
| s += '\n' + '\n '.join(o.doc.strip().split('\n')) | ||
| #s += '\n' + '\n '.join(o.doc.strip().split('\n')) |
There was a problem hiding this comment.
supposed to be commented out?
There was a problem hiding this comment.
aha, thanks for the catch (should just be removed, it was the original line)
so they render nice with sphinx without warnings
jorisvandenbossche
added a commit
that referenced
this pull request
May 26, 2014
DOC: clean-up docstrings of option functions
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.
Some clean-up after my last additions to api.rst to get rid off all warnings: