Tshepang Lekhonkhobe <tshep...@gmail.com> added the comment:
> Ezio Melotti <ezio.melo...@gmail.com> added the comment:
> Another idea that we were discussing on IRC (and IIRC on another issue that I
> can't find anymore), was to add at the top a table like:
> ----------------------------------------
> arguments *arg*
> strong text **strong**
> code snippets ``print('hello world')``
> True/False/None ``True``
> functions :func:`sorted`
> methods :meth:`list.sort`
> ...
> ----------------------------------------
>
> This will allow people that are searching for the right markup to find
> quickly what role they should use.
That would be a good idea. A quick ref check without all the prose.
> I also agree with Éric that you should always build the doc anyway to check
> for errors. Sometimes it happens that I have to experiment a bit if I'm
> using some uncommon role/directive, but that doesn't happen often, and
> building the doc a few times is not a problem for me in these cases.
I also agree. I'm just thinking someone who reads that doc should be
able to see the output without building anything. That is, reading the
doc doesn't necessarily mean you want to apply what you just learned
"right now". There's also "just in case" or "curiosity" learning.
----------
_______________________________________
Python tracker <rep...@bugs.python.org>
<http://bugs.python.org/issue14218>
_______________________________________
_______________________________________________
Python-bugs-list mailing list
Unsubscribe:
http://mail.python.org/mailman/options/python-bugs-list/archive%40mail-archive.com
