numpydoc

numpydoc copied to clipboard

DOC: Use `:ref:` when referring to section headers

1

This PR makes a few minor changes to more consistently use the `:ref:` role to link to different sections in different parts of the numpydoc standard. I also used the...

namurphy

DOC: include positional-only and keyword-only parameters in standard

11

This PR adds keyword-only parameters to the numpydoc style guide, which were added in [PEP 3102](https://www.python.org/dev/peps/pep-3102/). This change would specify that `keyword-only` gets added next to the type information, like...

namurphy

DOC: Describe how to include parameter sizes & shapes

10

This pull request describes how to include size & shape information for a parameter in the type line of the **Parameters** section of docstrings. I adapted the example from [`numpy.outer`](https://github.com/numpy/numpy/blob/54c52f13713f3d21795926ca4dbb27e16fada171/numpy/core/numeric.py#L857-L942)....

namurphy

Review and document conventions that are in use

12

I am not sure if here is a good place of if it would be better to open a topic on https://discuss.scientific-python.org/. Happy to move it somewhere else if that...

OriolAbril

"Unknown section" error because of something in a Literal block

1

I have the following docstring: ``` Returns the quadric with matrix :: I | ---+----- | 0 1 | 1 0 Returns ------- Quadric ``` Building this, I get the...

LeanderBlume

Future: `_traverse_or_findall` -> `findall` when docutils 0.18 is the minimum version

1

Just opening a tracking issue for future cleanup. The `_traverse_or_findall` shim can be removed in the future when the minimum supported docutils is bumped to `0.18`. See #403 for details....

rossbar

Can we have subsections in Examples?

1

For a docstrings with several examples, it would be nice to be able to clearly separate them: ``` Examples ------------- Here we show two examples of our awesome function. First...

ev-br

In an ETL project, a common pattern to pass pandas DataFrame objects from one method to another in order to enrich them with new columns. However, I'm struggling with finding...

troyswanson

Support type annotations in `Returns` and `Yields` sections

10

Currently, when using `numpydoc`-style docstrings alongside Python type annotation, the types of returns or yields must be specified twice, which is tedious and also error prone. I would like to...

marvinpfoertner

improve section detection

4

Potentially fixes #316. This tries to allow parsing sections which are not separated by blank lines (there should probably be a warning in that case, I'll add that once the...

keewis