<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
</head>
<body>
<p>Which docstring formatting standard am I supposed to be using? I
noticed that some existing docstrings place an @ in front of
parameter names in-line with otherwise unformatted descriptions,
but that doesn't correspond to any of these:<br>
</p>
<p style="hyphens: auto; line-height: 1.4em; color: rgb(62, 67, 73);
font-family: Georgia, serif; font-size: 17px; font-style: normal;
font-variant-ligatures: normal; font-variant-caps: normal;
font-weight: 400; letter-spacing: normal; orphans: 2; text-align:
start; text-indent: 0px; text-transform: none; widows: 2;
word-spacing: 0px; -webkit-text-stroke-width: 0px; white-space:
normal; background-color: rgb(255, 255, 255);
text-decoration-thickness: initial; text-decoration-style:
initial; text-decoration-color: initial;">Epytext syntax:</p>
<div class="highlight-default notranslate" style="clear: both;
margin: 1em 0px; color: rgb(62, 67, 73); font-family: Georgia,
serif; font-size: 17px; font-style: normal;
font-variant-ligatures: normal; font-variant-caps: normal;
font-weight: 400; letter-spacing: normal; orphans: 2; text-align:
start; text-indent: 0px; text-transform: none; widows: 2;
word-spacing: 0px; -webkit-text-stroke-width: 0px; white-space:
normal; background-color: rgb(255, 255, 255);
text-decoration-thickness: initial; text-decoration-style:
initial; text-decoration-color: initial;">
<div class="highlight" style="background: rgb(255, 255, 255);">
<pre style="line-height: 1.3em; overflow: auto hidden; clear: both; font-family: Consolas, Menlo, "DejaVu Sans Mono", "Bitstream Vera Sans Mono", monospace; font-size: 0.9em; background: rgb(238, 238, 238); padding: 7px 30px; margin: 0px;"><span></span><span class="nd" style="color: rgb(136, 136, 136);">@type</span> <span class="n" style="color: rgb(0, 0, 0);">num_dogs</span><span class="p" style="color: rgb(0, 0, 0); font-weight: bold;">:</span> <span class="nb" style="color: rgb(0, 68, 97);">int</span>
<span class="nd" style="color: rgb(136, 136, 136);">@param</span> <span class="n" style="color: rgb(0, 0, 0);">num_dogs</span><span class="p" style="color: rgb(0, 0, 0); font-weight: bold;">:</span> <span class="n" style="color: rgb(0, 0, 0);">the</span> <span class="n" style="color: rgb(0, 0, 0);">number</span> <span class="n" style="color: rgb(0, 0, 0);">of</span> <span class="n" style="color: rgb(0, 0, 0);">dogs</span>
</pre>
</div>
</div>
<p style="hyphens: auto; line-height: 1.4em; color: rgb(62, 67, 73);
font-family: Georgia, serif; font-size: 17px; font-style: normal;
font-variant-ligatures: normal; font-variant-caps: normal;
font-weight: 400; letter-spacing: normal; orphans: 2; text-align:
start; text-indent: 0px; text-transform: none; widows: 2;
word-spacing: 0px; -webkit-text-stroke-width: 0px; white-space:
normal; background-color: rgb(255, 255, 255);
text-decoration-thickness: initial; text-decoration-style:
initial; text-decoration-color: initial;">Sphinx syntax:</p>
<div class="highlight-default notranslate" style="clear: both;
margin: 1em 0px; color: rgb(62, 67, 73); font-family: Georgia,
serif; font-size: 17px; font-style: normal;
font-variant-ligatures: normal; font-variant-caps: normal;
font-weight: 400; letter-spacing: normal; orphans: 2; text-align:
start; text-indent: 0px; text-transform: none; widows: 2;
word-spacing: 0px; -webkit-text-stroke-width: 0px; white-space:
normal; background-color: rgb(255, 255, 255);
text-decoration-thickness: initial; text-decoration-style:
initial; text-decoration-color: initial;">
<div class="highlight" style="background: rgb(255, 255, 255);">
<pre style="line-height: 1.3em; overflow: auto hidden; clear: both; font-family: Consolas, Menlo, "DejaVu Sans Mono", "Bitstream Vera Sans Mono", monospace; font-size: 0.9em; background: rgb(238, 238, 238); padding: 7px 30px; margin: 0px;"><span></span><span class="p" style="color: rgb(0, 0, 0); font-weight: bold;">:</span><span class="n" style="color: rgb(0, 0, 0);">param</span> <span class="n" style="color: rgb(0, 0, 0);">param1</span><span class="p" style="color: rgb(0, 0, 0); font-weight: bold;">:</span> <span class="n" style="color: rgb(0, 0, 0);">The</span> <span class="n" style="color: rgb(0, 0, 0);">first</span> <span class="n" style="color: rgb(0, 0, 0);">parameter</span><span class="p" style="color: rgb(0, 0, 0); font-weight: bold;">,</span> <span class="n" style="color: rgb(0, 0, 0);">defaults</span> <span class="n" style="color: rgb(0, 0, 0);">to</span> <span class="mf" style="color: rgb(153, 0, 0);">1.</span>
<span class="p" style="color: rgb(0, 0, 0); font-weight: bold;">:</span><span class="nb" style="color: rgb(0, 68, 97);">type</span><span class="p" style="color: rgb(0, 0, 0); font-weight: bold;">:</span> <span class="nb" style="color: rgb(0, 68, 97);">int</span>
</pre>
</div>
</div>
<p style="hyphens: auto; line-height: 1.4em; color: rgb(62, 67, 73);
font-family: Georgia, serif; font-size: 17px; font-style: normal;
font-variant-ligatures: normal; font-variant-caps: normal;
font-weight: 400; letter-spacing: normal; orphans: 2; text-align:
start; text-indent: 0px; text-transform: none; widows: 2;
word-spacing: 0px; -webkit-text-stroke-width: 0px; white-space:
normal; background-color: rgb(255, 255, 255);
text-decoration-thickness: initial; text-decoration-style:
initial; text-decoration-color: initial;">Google syntax:</p>
<div class="highlight-default notranslate" style="clear: both;
margin: 1em 0px; color: rgb(62, 67, 73); font-family: Georgia,
serif; font-size: 17px; font-style: normal;
font-variant-ligatures: normal; font-variant-caps: normal;
font-weight: 400; letter-spacing: normal; orphans: 2; text-align:
start; text-indent: 0px; text-transform: none; widows: 2;
word-spacing: 0px; -webkit-text-stroke-width: 0px; white-space:
normal; background-color: rgb(255, 255, 255);
text-decoration-thickness: initial; text-decoration-style:
initial; text-decoration-color: initial;">
<div class="highlight" style="background: rgb(255, 255, 255);">
<pre style="line-height: 1.3em; overflow: auto hidden; clear: both; font-family: Consolas, Menlo, "DejaVu Sans Mono", "Bitstream Vera Sans Mono", monospace; font-size: 0.9em; background: rgb(238, 238, 238); padding: 7px 30px; margin: 0px;"><span></span><span class="n" style="color: rgb(0, 0, 0);">Args</span><span class="p" style="color: rgb(0, 0, 0); font-weight: bold;">:</span>
<span class="n" style="color: rgb(0, 0, 0);">param1</span> <span class="p" style="color: rgb(0, 0, 0); font-weight: bold;">(</span><span class="nb" style="color: rgb(0, 68, 97);">int</span><span class="p" style="color: rgb(0, 0, 0); font-weight: bold;">):</span> <span class="n" style="color: rgb(0, 0, 0);">The</span> <span class="n" style="color: rgb(0, 0, 0);">first</span> <span class="n" style="color: rgb(0, 0, 0);">parameter</span><span class="o" style="color: rgb(88, 40, 0);">.</span>
</pre>
</div>
</div>
<p style="hyphens: auto; line-height: 1.4em; color: rgb(62, 67, 73);
font-family: Georgia, serif; font-size: 17px; font-style: normal;
font-variant-ligatures: normal; font-variant-caps: normal;
font-weight: 400; letter-spacing: normal; orphans: 2; text-align:
start; text-indent: 0px; text-transform: none; widows: 2;
word-spacing: 0px; -webkit-text-stroke-width: 0px; white-space:
normal; background-color: rgb(255, 255, 255);
text-decoration-thickness: initial; text-decoration-style:
initial; text-decoration-color: initial;">NumPy syntax:</p>
<div class="highlight-default notranslate" style="clear: both;
margin: 1em 0px; color: rgb(62, 67, 73); font-family: Georgia,
serif; font-size: 17px; font-style: normal;
font-variant-ligatures: normal; font-variant-caps: normal;
font-weight: 400; letter-spacing: normal; orphans: 2; text-align:
start; text-indent: 0px; text-transform: none; widows: 2;
word-spacing: 0px; -webkit-text-stroke-width: 0px; white-space:
normal; background-color: rgb(255, 255, 255);
text-decoration-thickness: initial; text-decoration-style:
initial; text-decoration-color: initial;">
<div class="highlight" style="background: rgb(255, 255, 255);">
<pre style="line-height: 1.3em; overflow: auto hidden; clear: both; font-family: Consolas, Menlo, "DejaVu Sans Mono", "Bitstream Vera Sans Mono", monospace; font-size: 0.9em; background: rgb(238, 238, 238); padding: 7px 30px; margin: 0px;"><span></span><span class="n" style="color: rgb(0, 0, 0);">Parameters</span>
<span class="o" style="color: rgb(88, 40, 0);">----------</span>
<span class="n" style="color: rgb(0, 0, 0);">param1</span> <span class="p" style="color: rgb(0, 0, 0); font-weight: bold;">:</span> <span class="nb" style="color: rgb(0, 68, 97);">int</span>
<span class="n" style="color: rgb(0, 0, 0);">The</span> <span class="n" style="color: rgb(0, 0, 0);">first</span> <span class="n" style="color: rgb(0, 0, 0);">parameter</span><span class="o" style="color: rgb(88, 40, 0);">.</span></pre>
</div>
</div>
<p></p>
<p><br>
</p>
<p><br>
</p>
<p><br>
</p>
<p><br>
</p>
<div id="DAB4FAD8-2DD7-40BB-A1B8-4E2AA1F9FDF2"><br /><table style="border-top: 1px solid #D3D4DE;"><tr><td style="width: 55px; padding-top: 13px;"><a href="http://www.avg.com/email-signature?utm_medium=email&utm_source=link&utm_campaign=sig-email&utm_content=emailclient" target="_blank"><img src="https://s-install.avcdn.net/ipm/preview/icons/icon-envelope-tick-green-avg-v1.png" alt="" width="46" height="29" style="width: 46px; height: 29px;"/></a></td><td style="width: 470px; padding-top: 12px; color: #41424e; font-size: 13px; font-family: Arial, Helvetica, sans-serif; line-height: 18px;">Virus-free.<a href="http://www.avg.com/email-signature?utm_medium=email&utm_source=link&utm_campaign=sig-email&utm_content=emailclient" target="_blank" style="color: #4453ea;">www.avg.com</a></td></tr></table><a href="#DAB4FAD8-2DD7-40BB-A1B8-4E2AA1F9FDF2" width="1" height="1"> </a></div></body>
</html>