[docs] [issue18280] Documentation is too personalized

A.M. Kuchling report at bugs.python.org
Sun Jun 23 02:37:00 CEST 2013


A.M. Kuchling added the comment:

I've looked through the matches.  "I/O" and the -I command-line switch are false positives.  Many references in the FAQ ("How do I do X?"), but those don't need to be fixed.  

I think personalized references are most problematic when they're expressing uncertainty ("I don't know if we implement all of the spec") or opinions.  Sentences like "When I run this command under Linux, I see..." could be rewritten as "When *you* run this command...", but they don't seem worth fixing to me.

Files with personalized text are:

c-api/exceptions.rst
c-api/long.rst
distutils/builtdist.rst
extending/extending.rst
install/index.rst
library/audioop.rst
library/ctypes.rst
library/doctest.rst
library/heapq.rst
library/imaplib.rst
library/numbers.rst
library/ossaudiodev.rst
library/unittest.mock-examples.rst
library/unittest.mock.rst
reference/introduction.rst
tutorial/classes.rst

----------

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


More information about the docs mailing list