Repository navigation
rest+epydoc: fix keyword fields and blank lines - #189
Merged
Merged
Conversation
ReST read 🔑 as a keyword and did not know :kwarg: or :kwparam:. As in Sphinx, 🔑 is now a param and the other two are keywords. An empty :rtype: or :ytype: is ignored instead of giving the type "". Epydoc dropped the blank lines in a field's description, so its paragraphs ran together. It now keeps them, as ReST does.
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
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.
Covers these items from the BEHAVIOR.md review for #136.
:key:as a param, as Sphinx does, and:kwarg:and:kwparam:as keywords. Before,:key:was read as a keyword and:kwarg:gave a plain text item.:rtype:or:ytype:is now ignored. It used to set the return type to"".Case diffs: three files.
rest/compose_keeps_param_kind_01::key y:is now a param.auto/whitespace_blank_line/form-feedandtab: an Epydoc field keeps its blank line.Parity against origin/main: 1114 of 29184 docstrings differ (case 3, stdlib 0, the rest generated). The generated ones are mixed-style inputs whose Epydoc fields now keep their blank lines. The parse diffs are all in EPYDOC and AUTO, and the compose diffs follow from them.