This issue tracker has been migrated to GitHub, and is currently read-only.
For more information, see the GitHub FAQs in the Python's Developer Guide.

Author chris.jerdonek
Recipients chris.jerdonek, eric.araujo, ezio.melotti, georg.brandl, orsenthil, r.david.murray, sandro.tosi, tshepang
Date 2013-01-09.03:29:38
SpamBayes Score -1.0
Marked as misclassified Yes
Message-id <1357702181.06.0.0623563610466.issue16814@psf.upfronthosting.co.za>
In-reply-to
Content
For the record, we do have tutorial-like documentation and document more than one way to do things in multiple places throughout the devguide.  For example:

http://docs.python.org/devguide/faq.html#how-do-i-list-the-files-in-conflict-after-a-merge

Unlike the short options for long commands, though, it's not obvious to look for something like `make -C` (because you don't already know it's there).  That's why I think this option is more deserving.

Personally, when working on doc patches, I frequently go back and forth between `make html` and `hg diff`.  Knowing about -C means one doesn't have to cd up and down the directory each time or double-check what directory one is in.

I think it's okay and should even be a goal of the devguide to point out more efficient ways to contribute, which may sometimes involve saying more than the minimum (e.g. saying how something works, or stating a more "advanced" way to do something).  I still think we should strive for conciseness within those constraints.  Here is a new patch that makes the current language more concise in addition to some other minor changes.
History
Date User Action Args
2013-01-09 03:29:41chris.jerdoneksetrecipients: + chris.jerdonek, georg.brandl, orsenthil, ezio.melotti, eric.araujo, r.david.murray, sandro.tosi, tshepang
2013-01-09 03:29:41chris.jerdoneksetmessageid: <1357702181.06.0.0623563610466.issue16814@psf.upfronthosting.co.za>
2013-01-09 03:29:40chris.jerdoneklinkissue16814 messages
2013-01-09 03:29:40chris.jerdonekcreate