https://www.thinkulum.net/w/index.php?action=history&feed=atom&title=Software_Development%2FDocstrings 2026-05-22T00:49:11Z Revision history for this page on the wiki MediaWiki 1.37.1 https://www.thinkulum.net/w/index.php?title=Software_Development/Docstrings&diff=390&oldid=prev 2019-02-22T05:48:01Z

<p>Added the article.</p> <p><b>New page</b></p><div>Here are discussions of what to put in a docstring:<br /> <br /> * [https://www.python.org/dev/peps/pep-0257/ PEP 257 -- Docstring Conventions - Python.org]<br /> * [http://stackoverflow.com/questions/3898572/what-is-the-standard-python-docstring-format What is the standard Python docstring format? - Stack Overflow]<br /> * [https://en.wikipedia.org/wiki/Javadoc Javadoc - Wikipedia] - A documentation generator for Java code. The conventions Javadoc understands can be adapted for other languages. I'm evaluating tools for processing Python docstrings that use this format.<br /> <br /> My snippets for functions and modules will include docstring outlines.<br /> <br /> Then you need a tool to present the docstrings to the reader. For now I'm going with Sphinx, since Python developers seem to prefer it. Since it formats more than just docstrings, I've put its links in the &quot;Project documentation&quot; section below.<br /> <br /> [[Category:Programming]]<br /> [[Category:Essays]]<br /> [[Category:Developing]]</div>

Andy Culbertson