| msg267543 - (view) |
Author: Anilyka Barry (abarry) *  |
Date: 2016-06-06 18:59 |
| The NotImplemented docs aren't explicit enough when it comes to where it can/should be used. Patch attached. |
|
|
| msg267567 - (view) |
Author: Guido van Rossum (gvanrossum) *  |
Date: 2016-06-06 22:22 |
| LGTM |
|
|
| msg267568 - (view) |
Author: Raymond Hettinger (rhettinger) * |
Date: 2016-06-06 22:44 |
| It would be nice to also clarify and differentiate NotImplementedError as well. |
|
|
| msg267588 - (view) |
Author: Anilyka Barry (abarry) * |
Date: 2016-06-07 04:35 |
| Added further notes to `NotImplemented` and `NotImplementedError` to clearly state the differences between the two. I also added some more details to `TypeError` - I'm amazed at how little was described for such a common exception! Maybe I explained a bit too thoroughly in some parts, but I like to have everything unambigous and well explained. I haven't yet spent the time to learn how to build documentation (Soon™), so I'm going off the existing docs, and I try to follow the style as closely as possible. |
|
|
| msg267593 - (view) |
Author: Anilyka Barry (abarry) * |
Date: 2016-06-07 05:15 |
| New patch with small tweaks. Thanks Jelle for the comments! |
|
|
| msg267724 - (view) |
Author: Anilyka Barry (abarry) * |
Date: 2016-06-07 18:52 |
| More tweaks after Ethan's comments. This is starting to get way outside of the realm of NotImplemented, but it still makes for a good reference to point confused users at. |
|
|
| msg267776 - (view) |
Author: Martin Panter (martin.panter) * |
Date: 2016-06-08 04:38 |
| Emanuel, have you seen <https://docs.python.org/devguide/documenting.html#building-the-documentation>? From my experience, install Sphinx, and then “make -C Doc/ html”. About the patch, I think the “.. note” boxes should be intended under the NotImplementedError heading. The current box looks wrong sandwiched between NotImplemnted and Ellipsis. (Personally I think “Note” boxes are an annoying distraction anyway, and should normally be written into the surrounding text. In this case “Note that” inside a “Note” box seems doubly redundant. But other people seem to like them, so I try to resist complaining :) |
|
|
| msg267843 - (view) |
Author: Anilyka Barry (abarry) * |
Date: 2016-06-08 12:59 |
| Martin: yes, I plan to install Sphinx soon enough, so that I can build the docs. As for the notes part, I indented it exactly like it was indented for other existing notes boxes in the same file. I'll change that if needed though. |
|
|
| msg267851 - (view) |
Author: Martin Panter (martin.panter) * |
Date: 2016-06-08 13:44 |
| I think the box about NotImplementedError needs indenting too. See the box for <https://docs.python.org/3.5/library/functions.html#locals> for a better example. |
|
|
| msg269911 - (view) |
Author: Anilyka Barry (abarry) * |
Date: 2016-07-06 21:51 |
| New patch with proper indenting, should be good as far as formatting is concerned :) |
|
|
| msg271825 - (view) |
Author: Anilyka Barry (abarry) * |
Date: 2016-08-02 14:10 |
| Obligatory monthly ping. |
|
|
| msg271831 - (view) |
Author: Ethan Furman (ethan.furman) * |
Date: 2016-08-02 16:40 |
| Did a little rewording and trimming (and formatting). Tried to keep the ideas while not being so verbose. |
|
|
| msg271832 - (view) |
Author: Anilyka Barry (abarry) * |
Date: 2016-08-02 17:00 |
| Thanks Ethan for the improved patch! Pointed out a typo and some nits, but other than that it's mostly good. I'm not that good at brevity, and I think your patch is much better on that regard :) |
|
|
| msg271833 - (view) |
Author: Ethan Furman (ethan.furman) * |
Date: 2016-08-02 17:19 |
| Fixed the typos (thanks!), removed the self-reference, and went with "similar names and purposes". |
|
|
| msg272065 - (view) |
Author: Roundup Robot (python-dev) |
Date: 2016-08-05 22:10 |
| New changeset 142f5325af06 by Ethan Furman in branch 'default': Clarify NotImplemented vs NotImplementedError. Initial patch by Emmanuel Barry. Closes issue 27242. https://hg.python.org/cpython/rev/142f5325af06 |
|
|