>
> 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.


For the case that a function is meant to be internal but can be accessed by 
an end user via say tab completion (which I thought is the case for the 
original example), it should carry a docstring to guide the user away. 

If the name of the function starts with an underline, this should be enough 
to frighten away the user. 

-- 
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.

Reply via email to