jiminy icon indicating copy to clipboard operation
jiminy copied to clipboard

[misc] Bad docstring formatting for Boost::Python bindings.

Open Arpafaucon opened this issue 2 years ago • 2 comments

image

I suppose the text documents an overload to the function, without being sure.

Also, is the [ ] nesting to indicate optionality correct ? This one indicates that load_visual_meshes being present is acceptable only if has_freeflyer is present too

Arpafaucon avatar Aug 26 '22 11:08 Arpafaucon

I'm afraid I cannot do much about it. This documentation is automatically generated by sphinx from boost python bindings. I don't know why there is this strange recursion of optional parameters, and the convention is strange overall.

duburcqa avatar Aug 26 '22 13:08 duburcqa

Here is the culprit !

duburcqa avatar Aug 26 '22 13:08 duburcqa

Stubs files are now provided. Just waiting for Sphinx to support pyi files to generate doc. This issue is documented here.

duburcqa avatar Mar 11 '23 08:03 duburcqa