Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Napoleon: Support NumpyDoc "Receives" docstring section #8236

Closed
tcjennings opened this issue Sep 22, 2020 · 1 comment
Closed

Napoleon: Support NumpyDoc "Receives" docstring section #8236

tcjennings opened this issue Sep 22, 2020 · 1 comment
Labels
Milestone

Comments

@tcjennings
Copy link

Support the "Receives" section of NumpyDoc guidelines; it is related to Yields, which is already supported.

https://numpydoc.readthedocs.io/en/latest/format.html#sections

Receives

Explanation of parameters passed to a generator’s .send() method, formatted as for Parameters, above. Since, like for Yields and Returns, a single object is always passed to the method, this may describe either the single parameter, or positional arguments passed as a tuple. If a docstring includes Receives it must also include Yields.

@tcjennings tcjennings added the type:enhancement enhance or introduce a new feature label Sep 22, 2020
@tk0miya tk0miya added this to the 3.3.0 milestone Sep 27, 2020
@tk0miya
Copy link
Member

tk0miya commented Sep 27, 2020

Reasonable. It should be supported.

@tk0miya tk0miya modified the milestones: 3.3.0, 3.4.0 Oct 3, 2020
tk0miya added a commit that referenced this issue Dec 20, 2020
Close #8236: napoleon: Support numpydoc's "Receives" section
@github-actions github-actions bot locked as resolved and limited conversation to collaborators Jul 17, 2021
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
Projects
None yet
Development

No branches or pull requests

2 participants