Alexander Belopolsky added the comment: On Sep 3, 2012, at 1:22 PM, Stefan Krah <rep...@bugs.python.org> wrote:
> Personally I'd also prefer if all > docstrings go into a separate section. I always perceive docstrings > as noise that takes up precious vertical space, so for _decimal I even > banned them into docstrings.h. > > I don't know if there's any kind of convention for that though. I've seen two types of convention: a docs trying before function definition and docstring after function body. I prefer the first because the docstring doubles as a short comment describing the function that follows. If we put docstrings in a separate section, we may see comments above functions diverge from docstrings over time. On the other hand, this is not that important and consolidating the changes in one section will make 3.2 to 3.3 merge easier. I'll consolidate and wait for someone else to complain. :-) ---------- nosy: +Alexander.Belopolsky _______________________________________ Python tracker <rep...@bugs.python.org> <http://bugs.python.org/issue15855> _______________________________________ _______________________________________________ Python-bugs-list mailing list Unsubscribe: http://mail.python.org/mailman/options/python-bugs-list/archive%40mail-archive.com
