Use type and default option to confval in napoleon docs #13094
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
AA-Turner
requested changes
Nov 1, 2024
Snoopy1866
force-pushed
the
docs-usage-extension-napoleon-napoleon_attr_annotations
branch
from
0ec4a68 to
5dccd13
Compare
Snoopy1866
commented
Nov 5, 2024
doc/usage/extensions/napoleon.rst
Outdated
| @@ -550,9 +575,10 @@ sure that "sphinx.ext.napoleon" is enabled in ``conf.py``:: | |||
| .. versionadded:: 3.4 | |||
|
|
|||
| .. confval:: napoleon_custom_sections | |||
| :type: `Optional[Sequence[str | Sequence[str, str]]]` | |||
There was a problem hiding this comment.
Is it necessary to use Sequence instead of list or tuple here? And should I use the |, or nested Optional?
Snoopy1866
commented
Nov 5, 2024
Snoopy1866
changed the title
napoleon_attr_annotations
|
I have updated the PR title to reflect changes not only to the documentation of the The previous title no longer accurately represented the scope of the updates. However, I have not changed the branch name, as doing so would close this PR. |
|
Inspired by the below code, I add the sphinx/doc/usage/configuration.rst Lines 2917 to 2919 in 230ccf2 |
|
|
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.
Subject: Use type and default option to confval in napoleon docs
Feature or Bugfix
Purpose
Use type and default option to confval in napoleon docs.
Detail
None
Relates
None