Jeroen Demeyer wrote: > For functions which are meant to be called directly by end users, > doctests are essential because they should show examples of how the > function should actually be used. However, for internal functions or > things like __init__, it is often not easy to write meaningful > docstrings.
I suspect the policy of doctesting every function also discourages people from breaking their code into simpler functions. And it is not clear that it improves the documentation (or testing) even of the helper functions themselves, because pretty often it would make more sense to describe and test, say, a number of private methods of a class at once, in the class docstring. -- Marc -- You received this message because you are subscribed to the Google Groups "sage-devel" group. To unsubscribe from this group and stop receiving emails from it, send an email to sage-devel+unsubscr...@googlegroups.com. To post to this group, send email to sage-devel@googlegroups.com. Visit this group at https://groups.google.com/group/sage-devel. For more options, visit https://groups.google.com/d/optout.
