Author rurpy2
Recipients docs@python, ezio.melotti, rhettinger, rurpy2
Date 2012-12-12.18:20:16
SpamBayes Score -1.0
Marked as misclassified Yes
Message-id <1355336417.49.0.893154208266.issue16665@psf.upfronthosting.co.za>
In-reply-to
Content
Raymond Hettinger (rhettinger) msg177365:
> For some of the points, a couple examples will do a better job of explaining hex() that trying to write-out the full code specification in prose.  

Examples should never substitute for a clear, complete and concise description.  Examples serve to illustrate and clarify a description.  An example can only describe usage at a single point in the solution space.  The prose description (when well written) describes the total solution space.  

> Overly wordy documentation is harder to use than something short that addresses the primary use case.

No comments in this issue have suggested providing an "overly wordy" description.  The suggestion was for wording that accurately and concisely describes the behavior of the hex() function.  That is what good reference material is supposed to do.

Reference documentation should describe the behavior of its subject including any corner cases.  Addressing only "the primary use case" is not sufficient.  For addressing the primary use case, supplement the prose with an example.

> Also, the suggested "notes" editorialize and venture into the realm of personal coding preferences.

That characterization is incorrect.  
 
There is no editorializing (if this in reference to the word "flexible" in the note).  It is a fact that string formatting with the %x specifier also converts to hex and offers more control over the output than the hex() function does.  A reader interested in the hex() function should be apprised of this alternative.  Perhaps there is some other word that you would find more neutral than "flexible"?

There is no venturing into personal coding preferences -- only the factual and appropriate mention of an alternative.

One of the cheapest, easiest ways of improving documentation is good cross-referencing to related items.
History
Date User Action Args
2012-12-12 18:20:17rurpy2setrecipients: + rurpy2, rhettinger, ezio.melotti, docs@python
2012-12-12 18:20:17rurpy2setmessageid: <1355336417.49.0.893154208266.issue16665@psf.upfronthosting.co.za>
2012-12-12 18:20:17rurpy2linkissue16665 messages
2012-12-12 18:20:16rurpy2create