8000 Docstring section "Other Parameters" not rendering with rest of table · Issue #6924 · matplotlib/matplotlib · GitHub
[go: up one dir, main page]

Skip to content
Docstring section "Other Parameters" not rendering with rest of table #6924
Closed
@LindyBalboa

Description

@LindyBalboa

It has been bothering me that in general, kwargs are not very uniform at all in the docs. In many places they are listed after a simple "Addition keyword arguments... : ". Numpydoc does allow for the section Other Parameters (underscored with dashes) but it does not seem to render properly with the Parameters and Returns section table. The Other Parameters section doesn't seem to actually be used in the numpy docs. However, there are several instances of it in mpl/axes/_axes.py.

Looking at the html in a browser inspector, you can see that Parameters and Returns are the header to a <tr> and the contents are in the respective <td>. However, with Other Parameters, the contents are being inserted into a new <tr> following the Other Parameters row.

Metadata

Metadata

Assignees

No one assigned

    Type

    No type

    Projects

    No projects

    Milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions

      0