Open demisjohn opened 6 years ago
Can just add a python script file, which adds a __doc__
string literal """
to each object, although docstring and actual code would then be separated into different files which is not ideal.
Some links on adding Python docstrings to Boost code. It sounds complicated as it's all in the Boost c-wrapper thingy, which I don't understand yet:
https://stackoverflow.com/questions/15625065/define-a-boostfunction-with-a-docstring-boostpython https://stackoverflow.com/questions/18340500/boostpython-long-structured-docstrings Boost documentation: https://www.boost.org/doc/libs/1_61_0/libs/python/doc/html/reference/function_invocation_and_creation/function_documentation.html
@jsenellart , do you have any insight into this issue? This is something I would love to work on, but the C/BOOST/Python wrapper functionality is beyond my pay grade. I'd love to find a way to type the Python docstring directly into the cpp file where the functions are defined, rather than in a separate python file.
From @demisjohn on March 7, 2018 13:51
Currently, getting
help()
on a boost object (defined in C I think), does not show any useful user-written documentation on how to use the object.Should add documentation to clarify how to use these objects.
Example of
help( camfr.Section )
, which should say something likeinstead we get a cryptic:
Copied from original issue: demisjohn/CAMFR#8