New submission from Éric Araujo <mer...@netwok.org>:

I picked up a few files in Doc/library and updated their markup to use 
directives nesting.  The attached patch is the result; it’s a lot of changes 
for small benefit.  If we think it’s a good change anyway, I have two questions

- Do you think it would be a good idea to have the -checkins emails ignore 
whitespace changes in some cases?  (I’m thinking a magic string in the commit 
message)

- A number of files have a class directive near the top of the file, in the 
list of all public names, and a later section “XX objects” with the methods and 
attributes.  When this is changed to nested class/methods directives, sometimes 
the first class directive gets a noindex flag, but I think it should jsut be 
removed: the index in the sidebar is enough to let people jump to the doc.  Do 
you agree?

----------
assignee: docs@python
components: Documentation
messages: 143552
nosy: benjamin.peterson, docs@python, eric.araujo, georg.brandl
priority: normal
severity: normal
status: open
title: Nest class/methods directives in documentation
versions: Python 2.7, Python 3.2, Python 3.3

_______________________________________
Python tracker <rep...@bugs.python.org>
<http://bugs.python.org/issue12901>
_______________________________________
_______________________________________________
Python-bugs-list mailing list
Unsubscribe: 
http://mail.python.org/mailman/options/python-bugs-list/archive%40mail-archive.com

Reply via email to