[issue35449] documenting objects

Stefan Seefeld report at bugs.python.org
Mon Dec 10 06:49:02 EST 2018


Stefan Seefeld <stefan at seefeld.name> added the comment:

ad 3) sorry, I picked a bad example - I didn't mean to suggest that immutable objects should in fact become mutable by modifying their `__doc__` attribute.

ad 1) good, glad to hear that.

ad 2) fine. In fact, I'm not even proposing that per-instance docstring generation should be "on" by default. I'm merely asking whether the Python community can't (or even shouldn't) agree on a single convention for how to represent them, such that special tools can then support them, rather than different tools supporting different syntax / conventions.

----------

_______________________________________
Python tracker <report at bugs.python.org>
<https://bugs.python.org/issue35449>
_______________________________________


More information about the Python-bugs-list mailing list