hissp icon indicating copy to clipboard operation
hissp copied to clipboard

Fill in missing docstrings in public API

Open gilch opened this issue 5 years ago • 1 comments

Sphinx puts these in the docs as well. And they're useful for cross references. Doctest where applicable.

gilch avatar Nov 25 '20 04:11 gilch

Docstrings were fairly complete in the latest release. All public modules, classes, and functions/methods in the package .py files at least have a docstring, although some of them are terse. Not all public data variables have been documented (not that this is expected, Python has no particular mechanism for this, but Sphinx does), however certain important cases have been.

Now that #156 has been merged, .lissp files (i.e. macros.lissp) can also have doctests. Not all of the new macros from #155 have docstrings yet. They were very much in flux so documentation was not always worth the overhead, but they seem to have stabilized enough now.

gilch avatar Apr 10 '22 04:04 gilch