[issue13455] Reorganize tracker docs in the devguide

Antoine Pitrou report at bugs.python.org
Thu Nov 24 00:51:26 CET 2011


Antoine Pitrou <pitrou at free.fr> added the comment:

> This is true, however different people can figure out a different
> amount of things just by using and experiment with something.  While
> most of the tasks should be obvious, some are a bit more advanced, and
> even the "obvious" once might not be obvious for everyone.  So IMHO
> writing down a few sentences doesn't hurt.

Well, it does hurt, because the more sentences you write, the more the
devguide becomes bloated and difficult to follow (especially for
non-native English speakers who might not read English very fast). The
devguide is *already* too big.

The devguide was supposed to be something that you read quickly and
easily, not an exhaustive reference of how development works. Or at
least there should be a clear separation between the two (the guide
part, and the reference part). The guide part being the most important,
while the reference is really optional.

And, really, if you want people to feel more comfortable with the
tracker, it would be more productive to improve the tracker itself. No
amount of documentation will make a UI usable.

> Also the lines between developer, contributor, and user that reports
> an issue are not so well defined, so it might be ok to add information
> that are not aimed just to core-developers in the devguide.

The devguide is *not* primarily for core developers. It's for new
contributors who want to get set up, so that they don't give up in the
absence of clear indications. Being useful for core developers is a nice
extra, but it was not the original intent.

----------

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


More information about the Python-bugs-list mailing list