pymc
pymc copied to clipboard
DOC: shape_utils missing functions and misformatted returns
Issue with current documentation:
A function or two from the __all__ of the shape_utils module is missing from this documentation page here
Also, the rendering of those functions' returns are a bit messy. For instance, here
Idea or request for content:
Add docs for all the __all__ functions and break out the return into two or more lines in order to render better
might be good to carry the type hints into the docstring as well for display in the documentation
Can i work on this issue ?
Can i work on this issue ?
I'd say, go ahead!
__all__ and docs have different purposes. We want to be a bit more selective on what we show in the docs for users than we are about what is in __all__. The rendering of existing functions should be improved