<br><br><div class="gmail_quote">On Wed, Jul 7, 2010 at 9:24 PM, C. Titus Brown <span dir="ltr"><<a href="mailto:ctb@msu.edu">ctb@msu.edu</a>></span> wrote:<br><blockquote class="gmail_quote" style="margin:0 0 0 .8ex;border-left:1px #ccc solid;padding-left:1ex;">
Hi all,<br>
<br>
over on the fellowship o' the packaging mailing list, one of our GSoC students<br>
(merwok) asked about how much formatting info should go into Python stdlib<br>
docstrings. Right now the stdlib docstrings are primarily text, AFAIK; but<br>
with the switch to Sphinx for the official Python docs, should we permit<br>
ReST-general and/or Sphinx-specific markup in docstrings?<br>
<br>
Hmm, I don't actually see that the stdlib docstrings are imported into the<br>
Python documentation anywhere, so maybe the use of Sphinx isn't that<br>
relevant. But how about ReST in general?<br></blockquote><div><br></div><div>So will we be able to use .__docs__ within python interpretor, which is quite handy feature.</div><div>>>> print(os.getcwd.__doc__)</div>
<div>getcwd() -> path</div><div><br></div><div>Return a string representing the current working directory.</div><div>Also some python interpretors like bpython uses it ; a snapshot here - h<a href="ttp://cl.ly/c5bb3be4a01d9d44732f">ttp://cl.ly/c5bb3be4a01d9d44732f</a></div>
<div>So will it be ok to break them ?</div><div> </div><blockquote class="gmail_quote" style="margin:0 0 0 .8ex;border-left:1px #ccc solid;padding-left:1ex;">
<br>
See<br>
<br>
<a href="http://sphinx.pocoo.org/markup/index.html" target="_blank">http://sphinx.pocoo.org/markup/index.html</a><br>
<br>
for sphinx-specific markup constructs.<br>
<br>
thanks,<br>
--titus<br>
<font color="#888888">--<br>
C. Titus Brown, <a href="mailto:ctb@msu.edu">ctb@msu.edu</a><br><br>
</font></blockquote></div><br>