pymc icon indicating copy to clipboard operation
pymc copied to clipboard

DOC: shape_utils missing functions and misformatted returns

Open williambdean opened this issue 2 years ago • 4 comments

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

williambdean avatar Nov 09 '23 19:11 williambdean

might be good to carry the type hints into the docstring as well for display in the documentation

williambdean avatar Nov 09 '23 19:11 williambdean

Can i work on this issue ?

UditNayak avatar Nov 10 '23 18:11 UditNayak

Can i work on this issue ?

I'd say, go ahead!

williambdean avatar Nov 10 '23 18:11 williambdean

__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

ricardoV94 avatar Nov 11 '23 11:11 ricardoV94