Fix #7780: napoleon: multiple params declaration was wrongly recognized #8056
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
keewis
reviewed
Aug 5, 2020
tk0miya
force-pushed
the
7780_multi_params_in_numpydoc
branch
2 times, most recently
from
d6ef816
to
9266f02
Compare
Fix a testcase that added just before sphinx-doc#8049 merged.
tk0miya
force-pushed
the
7780_multi_params_in_numpydoc
branch
from
9266f02
to
be329d1
Compare
…y recognized So far, napoleon converts multiple paramaters declrarations to single paramaeter fields (`:param:` and `:type:`) unexpectedly. As a result, the output seems broken. This converts it to multiple parameter fields (a pair of field for each parameter declration) to build parameter successfully. Note: The conversion rule is available only when napoleon_use_params=True.
tk0miya
force-pushed
the
7780_multi_params_in_numpydoc
branch
from
be329d1
to
a4996f9
Compare
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.
Feature or Bugfix
Purpose
paramaeter fields (
:param:and:type:) unexpectedly. As a result,the output seems broken.
parameter declration) to build parameter successfully.