[New-bugs-announce] [issue18280] Documentation is too personalized

Serhiy Storchaka report at bugs.python.org
Sat Jun 22 10:28:34 CEST 2013


New submission from Serhiy Storchaka:

Some documentation files contain a number of I/my/me. Looks like they grew from personal modules and personal articles. Perhaps the official documentation needs more depersonalized style. Here is full list of such files:

Doc/c-api/exceptions.rst
Doc/c-api/long.rst
Doc/distutils/builtdist.rst
Doc/extending/extending.rst
Doc/extending/windows.rst
Doc/howto/argparse.rst
Doc/howto/curses.rst
Doc/howto/functional.rst
Doc/howto/regex.rst
Doc/howto/sockets.rst
Doc/howto/urllib2.rst
Doc/install/index.rst
Doc/library/audioop.rst
Doc/library/ctypes.rst
Doc/library/doctest.rst
Doc/library/heapq.rst
Doc/library/numbers.rst
Doc/library/ossaudiodev.rst
Doc/library/tk.rst
Doc/library/unittest.mock-examples.rst
Doc/library/unittest.mock.rst
Doc/reference/introduction.rst
Doc/tutorial/classes.rst

The list doesn't include FAQs where it may be appropriate and whatsnew files.

Andrew Kuchling recently has fixed Doc/howto/unicode.rst for this issue (as part of issue4153).

----------
assignee: docs at python
components: Documentation
messages: 191636
nosy: akuchling, docs at python, eric.araujo, ezio.melotti, georg.brandl, serhiy.storchaka
priority: normal
severity: normal
status: open
title: Documentation is too personalized
versions: Python 2.7, Python 3.3, Python 3.4

_______________________________________
Python tracker <report at bugs.python.org>
<http://bugs.python.org/issue18280>
_______________________________________


More information about the New-bugs-announce mailing list