doc: Fix truncated summary line #3235
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
niboshi
added
cat:bug
okuta
reviewed
Aug 31, 2017
|
|
||
| # Extract until the first blank line if any. | ||
| try: | ||
| doc = doc[:doc.index('')] |
There was a problem hiding this comment.
If doc does not have '', index() will raise ValueError (thus doc is not modified).
If it does, index() returns the index of '', so this statement extracts elements up until '', if any.
>>> a = ['a', 'b', 'c']
>>> a[:a.index('b')]
['a']
|
LGTM! |
okuta
added a commit
to okuta/chainer
that referenced
this pull request
Aug 31, 2017
doc: Fix truncated summary line
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.
Fixes #3234.
The problem is in autosummary's algorithm on parsing docstring: https://github.com/sphinx-doc/sphinx/blob/1.6.3/sphinx/ext/autosummary/__init__.py#L341
It treats the substring which ends with a period followed by a space (or a EOL) as the "first sentence", which trucate the string at e.g. "a.k.a. SOMETHING".
This PR interferes that algorithm by placing
\followed by an extra space before the existing space, which translates to an empty string. (I'm not sure if this is the correct use of the sequence. But at least it works)Additionally I put a code to check if docstrings are compliant with autosummary's algorithm.
TODO: Port to CuPy