[issue27242] Make the docs for NotImplemented & NotImplementedError unambigous

[Martin Panter]

Martin Panter added the comment:

I think the box about NotImplementedError needs indenting too. See the box for 
 for a better 
example.

--

___
Python tracker 

___
___
Python-bugs-list mailing list
Unsubscribe: 
https://mail.python.org/mailman/options/python-bugs-list/archive%40mail-archive.com

[issue27242] Make the docs for NotImplemented & NotImplementedError unambigous

[Emanuel Barry]

Emanuel Barry added the comment:

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.

--

___
Python tracker 

___
___
Python-bugs-list mailing list
Unsubscribe: 
https://mail.python.org/mailman/options/python-bugs-list/archive%40mail-archive.com

[issue27242] Make the docs for NotImplemented & NotImplementedError unambigous

[Martin Panter]

Martin Panter added the comment:

Emanuel, have you seen 
? 
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 :)

--
nosy: +martin.panter

___
Python tracker 

___
___
Python-bugs-list mailing list
Unsubscribe: 
https://mail.python.org/mailman/options/python-bugs-list/archive%40mail-archive.com

[issue27242] Make the docs for NotImplemented & NotImplementedError unambigous

[Emanuel Barry]

Emanuel Barry added the comment:

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.

--
Added file: 
http://bugs.python.org/file43284/NotImplemented_exceptions_wording_4.patch

___
Python tracker 

___
___
Python-bugs-list mailing list
Unsubscribe: 
https://mail.python.org/mailman/options/python-bugs-list/archive%40mail-archive.com

[issue27242] Make the docs for NotImplemented & NotImplementedError unambigous

[Emanuel Barry]

Emanuel Barry added the comment:

New patch with small tweaks. Thanks Jelle for the comments!

--
Added file: 
http://bugs.python.org/file43273/NotImplemented_exceptions_wording_3.patch

___
Python tracker 

___
___
Python-bugs-list mailing list
Unsubscribe: 
https://mail.python.org/mailman/options/python-bugs-list/archive%40mail-archive.com

[issue27242] Make the docs for NotImplemented & NotImplementedError unambigous

[Emanuel Barry]

Emanuel Barry added the comment:

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.

--
title: Clarify the use cases of NotImplemented in the docs -> Make the docs for 
NotImplemented & NotImplementedError unambigous
Added file: 
http://bugs.python.org/file43272/NotImplemented_exceptions_wording_2.patch

___
Python tracker 

___
___
Python-bugs-list mailing list
Unsubscribe: 
https://mail.python.org/mailman/options/python-bugs-list/archive%40mail-archive.com