[Python-Dev] Writable __doc__

Stephen J. Turnbull stephen at xemacs.org
Thu Jan 19 19:04:36 CET 2012

Ethan Furman writes:

 > Where does one draw the line between feature and bug?

Bug:      Doesn't work as documented.
Feature:  Works as expected but not documented[1] to do so.
Miracle:  Works as documented.[2]

Unspecified behavior that doesn't work as you expect is the unmarked
case (ie, none of the above).

The Devil's Dictionary defines feature somewhat differently:

Feature: Name for any behavior you don't feel like justifying to a user.

[1]  Including cases where the patch contains documentation but hasn't
been committed to trunk yet.

[2]  Python is pretty miraculous, isn't it?

More information about the Python-Dev mailing list