<?xml version="1.0"?>
<feed xmlns="http://www.w3.org/2005/Atom" xml:lang="en">
	<id>https://www.thinkulum.net/w/index.php?action=history&amp;feed=atom&amp;title=Software_Development%2FDocstrings</id>
	<title>Software Development/Docstrings - Revision history</title>
	<link rel="self" type="application/atom+xml" href="https://www.thinkulum.net/w/index.php?action=history&amp;feed=atom&amp;title=Software_Development%2FDocstrings"/>
	<link rel="alternate" type="text/html" href="https://www.thinkulum.net/w/index.php?title=Software_Development/Docstrings&amp;action=history"/>
	<updated>2026-11-17T22:05:25Z</updated>
	<subtitle>Revision history for this page on the wiki</subtitle>
	<generator>MediaWiki 1.37.1</generator>
	<entry>
		<id>https://www.thinkulum.net/w/index.php?title=Software_Development/Docstrings&amp;diff=390&amp;oldid=prev</id>
		<title>Andy Culbertson: Added the article.</title>
		<link rel="alternate" type="text/html" href="https://www.thinkulum.net/w/index.php?title=Software_Development/Docstrings&amp;diff=390&amp;oldid=prev"/>
		<updated>2019-02-22T05:48:01Z</updated>

		<summary type="html">&lt;p&gt;Added the article.&lt;/p&gt;
&lt;p&gt;&lt;b&gt;New page&lt;/b&gt;&lt;/p&gt;&lt;div&gt;Here are discussions of what to put in a docstring:&lt;br /&gt;
&lt;br /&gt;
* [https://www.python.org/dev/peps/pep-0257/ PEP 257 -- Docstring Conventions - Python.org]&lt;br /&gt;
* [http://stackoverflow.com/questions/3898572/what-is-the-standard-python-docstring-format What is the standard Python docstring format? - Stack Overflow]&lt;br /&gt;
* [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&amp;#039;m evaluating tools for processing Python docstrings that use this format.&lt;br /&gt;
&lt;br /&gt;
My snippets for functions and modules will include docstring outlines.&lt;br /&gt;
&lt;br /&gt;
Then you need a tool to present the docstrings to the reader. For now I&amp;#039;m going with Sphinx, since Python developers seem to prefer it. Since it formats more than just docstrings, I&amp;#039;ve put its links in the &amp;quot;Project documentation&amp;quot; section below.&lt;br /&gt;
&lt;br /&gt;
[[Category:Programming]]&lt;br /&gt;
[[Category:Essays]]&lt;br /&gt;
[[Category:Developing]]&lt;/div&gt;</summary>
		<author><name>Andy Culbertson</name></author>
	</entry>
</feed>