machow / plotnine-docs-demo

MIT License
0 stars 2 forks source link

Annotations inside numpy style docstring do not get interlinked #22

Open machow opened 1 year ago

machow commented 1 year ago

Currently, some functions have annotations (1) inside the docstring itself, AND in their (2) signature. We don't interlink for case (1), but if you remove those annotations (the top circled bit below), then the ones in the signature should be put in the parameters table instead. These do get interlinks.

Note that we could also extend the renderer to support case (1), in your _renderer.py file. We would use the numpydoc package to preprocess the annotations.

image