On Fri, 6 Nov 2015, Tom Boothby wrote:

A corollary to this is that relevant documentation should not exist in the TESTS block.

True.

And those edge cases should be documented.

Maybe. But something like Graph().is_connected() is easy to check, if the user wants to know if empty graph is defined to be connected.

On Fri, 6 Nov 2015, Michael Orlitzky wrote:

Write-in candidate: make foo? show the source code at the end of the
nicely-formatted docs, and then get rid of foo?? entirely.

-1. Too technical, will scare students.

(But teachers should show ?? functionality in some lesson, just as a side note. Maybe some on students will be future developers.)

--
Jori Mäntysalo

Reply via email to