On 7/7/2010 2:27 PM, Georg Brandl wrote:
Am 07.07.2010 19:53, schrieb Éric Araujo:
I promised to write a PEP about that some time in the future. (Probably after
3.2 final.)
It seems that projects putting Sphinxy reST in their doc are using
automatic doc generation. This is however not
Am 16.07.2010 22:55, schrieb Terry Reedy:
On 7/7/2010 2:27 PM, Georg Brandl wrote:
Am 07.07.2010 19:53, schrieb Éric Araujo:
I promised to write a PEP about that some time in the future. (Probably
after
3.2 final.)
It seems that projects putting Sphinxy reST in their doc are using
On 07/07/2010 12:30 PM, Georg Brandl wrote:
Am 07.07.2010 18:09, schrieb Michael Foord:
I would say that the major use of docstrings is for interactive help - so
interactive readability should be *the most important* (but perhaps not only)
factor when considering how to format standard
Am 09.07.2010 00:01, schrieb Fred Drake:
On Thu, Jul 8, 2010 at 5:42 PM, Alexander Belopolsky
alexander.belopol...@gmail.com wrote:
I am against mark-up in doc-strings, but this problem can be easily
solved by placing a magic character at __doc__[0] to indicate that the
rest is (mini)reST.
Georg Brandl g.bra...@gmx.net writes:
Am 08.07.2010 17:44, schrieb Martin Geisler:
Steve Holden st...@holdenweb.com writes:
Martin Geisler wrote:
Stephen J. Turnbull step...@xemacs.org writes:
Just ask Martin, there are too many possibilities here to worry
about. If maybe we want it,
On Fri, Jul 9, 2010 at 2:51 AM, Georg Brandl g.bra...@gmx.net wrote:
Yes, but[tm] it is not always easy to find the correct module to look for
__docformat__ when given an object.
True. That PEP was written before decorators were common, in
particular. That's changed the landscape in
On Jul 07, 2010, at 12:50 PM, Brett Cannon wrote:
On Wed, Jul 7, 2010 at 11:46, Antoine Pitrou solip...@pitrou.net
wrote:
On Wed, 7 Jul 2010 14:12:17 -0400
Barry Warsaw ba...@python.org wrote:
On Jul 07, 2010, at 07:30 PM, Georg Brandl wrote:
Overall, I think that we can make stdlib
On Fri, Jul 9, 2010 at 06:28, Barry Warsaw ba...@python.org wrote:
On Jul 07, 2010, at 12:50 PM, Brett Cannon wrote:
On Wed, Jul 7, 2010 at 11:46, Antoine Pitrou solip...@pitrou.net
wrote:
On Wed, 7 Jul 2010 14:12:17 -0400
Barry Warsaw ba...@python.org wrote:
On Jul 07, 2010, at 07:30 PM,
On Jul 09, 2010, at 11:55 AM, Brett Cannon wrote:
I think this is going to be something our crazy FLUFL likes but the
kids don't. =)
Don't worry. If you're lucky, you'll get old too. Your eyes will go bad and
your mind will think more about tapioca. By then you might even remember that
the
Stephen J. Turnbull step...@xemacs.org writes:
Benjamin Peterson writes:
2010/7/7 Stephen J. Turnbull step...@xemacs.org:
Antoine Pitrou writes:
http://selenic.com/hg/file/tip/mercurial/minirst.py
Given that Mercurial is GPL, this is probably of no use to us,
Martin Geisler wrote:
Stephen J. Turnbull step...@xemacs.org writes:
Benjamin Peterson writes:
2010/7/7 Stephen J. Turnbull step...@xemacs.org:
Antoine Pitrou writes:
http://selenic.com/hg/file/tip/mercurial/minirst.py
Given that Mercurial is GPL, this is
Steve Holden st...@holdenweb.com writes:
Martin Geisler wrote:
Stephen J. Turnbull step...@xemacs.org writes:
Just ask Martin, there are too many possibilities here to worry
about. If maybe we want it, and he is willing to contribute the
parts he wrote to Python under Python's license,
Am 08.07.2010 17:44, schrieb Martin Geisler:
Steve Holden st...@holdenweb.com writes:
Martin Geisler wrote:
Stephen J. Turnbull step...@xemacs.org writes:
Just ask Martin, there are too many possibilities here to worry
about. If maybe we want it, and he is willing to contribute the
parts
On Thu, Jul 8, 2010 at 5:21 PM, Georg Brandl g.bra...@gmx.net wrote:
Problem is, in the case of help() we have no way of knowing whether the
given __doc__ string is supposed to be (mini)reST. Of course, reverting
to showing the plain content on parsing errors is one possibility, but
I can
On Thu, Jul 8, 2010 at 5:21 PM, Georg Brandl g.bra...@gmx.net wrote:
..
Problem is, in the case of help() we have no way of knowing whether the
given __doc__ string is supposed to be (mini)reST.
I am against mark-up in doc-strings, but this problem can be easily
solved by placing a magic
On Thu, Jul 8, 2010 at 5:42 PM, Alexander Belopolsky
alexander.belopol...@gmail.com wrote:
I am against mark-up in doc-strings, but this problem can be easily
solved by placing a magic character at __doc__[0] to indicate that the
rest is (mini)reST.
Or __docformat__ can be set appropriately.
Fred Drake wrote:
On Thu, Jul 8, 2010 at 5:42 PM, Alexander Belopolsky
alexander.belopol...@gmail.com wrote:
I am against mark-up in doc-strings, but this problem can be easily
solved by placing a magic character at __doc__[0] to indicate that the
rest is (mini)reST.
Or __docformat__ can
Steve Holden writes:
That is _so_ Python 2 ;-)
High praise!
___
Python-Dev mailing list
Python-Dev@python.org
http://mail.python.org/mailman/listinfo/python-dev
Unsubscribe:
Hi all,
over on the fellowship o' the packaging mailing list, one of our GSoC students
(merwok) asked about how much formatting info should go into Python stdlib
docstrings. Right now the stdlib docstrings are primarily text, AFAIK; but
with the switch to Sphinx for the official Python docs,
On Wed, Jul 7, 2010 at 9:24 PM, C. Titus Brown c...@msu.edu wrote:
Hi all,
over on the fellowship o' the packaging mailing list, one of our GSoC
students
(merwok) asked about how much formatting info should go into Python stdlib
docstrings. Right now the stdlib docstrings are primarily
On Wed, Jul 07, 2010 at 09:36:10PM +0530, Shashwat Anand wrote:
On Wed, Jul 7, 2010 at 9:24 PM, C. Titus Brown c...@msu.edu wrote:
Hi all,
over on the fellowship o' the packaging mailing list, one of our GSoC
students
(merwok) asked about how much formatting info should go into Python
On 07/07/2010 17:06, Shashwat Anand wrote:
On Wed, Jul 7, 2010 at 9:24 PM, C. Titus Brown c...@msu.edu
mailto:c...@msu.edu wrote:
Hi all,
over on the fellowship o' the packaging mailing list, one of our
GSoC students
(merwok) asked about how much formatting info should go
On Wed, Jul 07, 2010 at 05:09:40PM +0100, Michael Foord wrote:
On 07/07/2010 17:06, Shashwat Anand wrote:
On Wed, Jul 7, 2010 at 9:24 PM, C. Titus Brown c...@msu.edu
mailto:c...@msu.edu wrote:
Hi all,
over on the fellowship o' the packaging mailing list, one of our
GSoC
On Wed, Jul 7, 2010 at 9:39 PM, Michael Foord fuzzy...@voidspace.org.ukwrote:
On 07/07/2010 17:06, Shashwat Anand wrote:
On Wed, Jul 7, 2010 at 9:24 PM, C. Titus Brown c...@msu.edu wrote:
Hi all,
over on the fellowship o' the packaging mailing list, one of our GSoC
students
(merwok)
Am 07.07.2010 18:09, schrieb Michael Foord:
Hi all,
over on the fellowship o' the packaging mailing list, one of our GSoC
students
(merwok) asked about how much formatting info should go into Python
stdlib
docstrings. Right now the stdlib docstrings are primarily text,
On Wed, Jul 7, 2010 at 11:00 PM, Georg Brandl g.bra...@gmx.net wrote:
Agreed. However, reST doesn't need to be less readable if the specific
inline markup is not used. For example, using `identifier` to refer to a
function or *var* to refer to a variable (which is already done at quite a
few
I promised to write a PEP about that some time in the future. (Probably after
3.2 final.)
Nice.
It seems that projects putting Sphinxy reST in their doc are using
automatic doc generation. This is however not always the best way to
make good doc, as demonstrated by Python’s hand-written,
On Jul 07, 2010, at 07:30 PM, Georg Brandl wrote:
Overall, I think that we can make stdlib docstrings valid reST -- even
if it's reST without much markup -- but valid, so that people pulling
in stdlib doc- strings into Sphinx docs won't get ugly warnings.
What I would *not* like to see is heavy
On 7/7/10 1:53 PM, Éric Araujo wrote:
I promised to write a PEP about that some time in the future. (Probably after
3.2 final.)
Nice.
It seems that projects putting Sphinxy reST in their doc are using
automatic doc generation. This is however not always the best way to
make good doc, as
Am 07.07.2010 19:53, schrieb Éric Araujo:
I promised to write a PEP about that some time in the future. (Probably
after
3.2 final.)
Nice.
It seems that projects putting Sphinxy reST in their doc are using
automatic doc generation. This is however not always the best way to
make good
On Wed, Jul 7, 2010 at 2:12 PM, Barry Warsaw ba...@python.org wrote:
..
Does it make sense to add (reST-style) epydoc markup for API signatures?
E.g.
def create_foo(name, parent=None):
Create the named foo.
The named foo must not already exist, but if optional `parent` is given,
On Wed, 7 Jul 2010 14:12:17 -0400
Barry Warsaw ba...@python.org wrote:
On Jul 07, 2010, at 07:30 PM, Georg Brandl wrote:
Overall, I think that we can make stdlib docstrings valid reST -- even
if it's reST without much markup -- but valid, so that people pulling
in stdlib doc- strings into
On Wed, Jul 7, 2010 at 2:27 PM, Georg Brandl g.bra...@gmx.net wrote:
I know, and this is what I originally intended for Sphinx. However, the calls
for automatic doc generation are very loud, and it's understandable that most
project can't afford writing their documentation twice.
The ability
On Wed, Jul 7, 2010 at 11:46, Antoine Pitrou solip...@pitrou.net wrote:
On Wed, 7 Jul 2010 14:12:17 -0400
Barry Warsaw ba...@python.org wrote:
On Jul 07, 2010, at 07:30 PM, Georg Brandl wrote:
Overall, I think that we can make stdlib docstrings valid reST -- even
if it's reST without much
On Wed, Jul 7, 2010 at 10:30, Georg Brandl g.bra...@gmx.net wrote:
Am 07.07.2010 18:09, schrieb Michael Foord:
Hi all,
over on the fellowship o' the packaging mailing list, one of our GSoC
students
(merwok) asked about how much formatting info should go into Python
stdlib
Am 07.07.2010 20:12, schrieb Barry Warsaw:
On Jul 07, 2010, at 07:30 PM, Georg Brandl wrote:
Overall, I think that we can make stdlib docstrings valid reST -- even
if it's reST without much markup -- but valid, so that people pulling
in stdlib doc- strings into Sphinx docs won't get ugly
C. Titus Brown c...@msu.edu writes:
I guess docutils isn't in the stdlib (should it be?) or else we could
modify 'help' to use it to prepare a straight text formatting.
We're using light-weight ReST markup in the Mercurial help texts and
transform it into straight text upon display in the
Am 07.07.2010 21:11, schrieb Fred Drake:
On Wed, Jul 7, 2010 at 2:27 PM, Georg Brandl g.bra...@gmx.net wrote:
I know, and this is what I originally intended for Sphinx. However, the
calls
for automatic doc generation are very loud, and it's understandable that most
project can't afford
Am 07.07.2010 21:52, schrieb Brett Cannon:
On Wed, Jul 7, 2010 at 10:30, Georg Brandl g.bra...@gmx.net wrote:
Am 07.07.2010 18:09, schrieb Michael Foord:
Hi all,
over on the fellowship o' the packaging mailing list, one of our GSoC
students
(merwok) asked about how much
On Wed, 07 Jul 2010 22:58:47 +0200
Martin Geisler m...@lazybytes.net wrote:
C. Titus Brown c...@msu.edu writes:
I guess docutils isn't in the stdlib (should it be?) or else we could
modify 'help' to use it to prepare a straight text formatting.
We're using light-weight ReST markup in
On 07/07/2010 21:54, Georg Brandl wrote:
Am 07.07.2010 20:12, schrieb Barry Warsaw:
On Jul 07, 2010, at 07:30 PM, Georg Brandl wrote:
Overall, I think that we can make stdlib docstrings valid reST -- even
if it's reST without much markup -- but valid, so that people pulling
in
On Wed, Jul 7, 2010 at 4:58 PM, Georg Brandl g.bra...@gmx.net wrote:
Let's say we were okay with giving up single-source docs,
It's not clear that this is a goal.
one potential
problem is that autodoc needs to import the modules in question, which
can become a problem, on one hand for
Antoine Pitrou writes:
http://selenic.com/hg/file/tip/mercurial/minirst.py
Given that Mercurial is GPL, this is probably of no use to us,
unfortunately.
Given that Martin apparently is the only or main author, I don't see a
problem as long as he's willing.
Martin?
2010/7/7 Stephen J. Turnbull step...@xemacs.org:
Antoine Pitrou writes:
http://selenic.com/hg/file/tip/mercurial/minirst.py
Given that Mercurial is GPL, this is probably of no use to us,
unfortunately.
Given that Martin apparently is the only or main author, I don't see a
Benjamin Peterson writes:
2010/7/7 Stephen J. Turnbull step...@xemacs.org:
Antoine Pitrou writes:
http://selenic.com/hg/file/tip/mercurial/minirst.py
Given that Mercurial is GPL, this is probably of no use to us,
unfortunately.
Given that Martin apparently is
45 matches
Mail list logo
