I think that warning is not formulated optimally, regardless of when it 
gets shown. Aren't the docstrings meant as user documentation? The average 
user probably doesn't care about whether "doctests pass" and may not even 
know what that means. Presumably, the marker is there because the module 
needs sage.graphs to function properly. So a warning about a missing stated 
prerequisite is more in order, possibly with a pointer to documentation how 
to get it.

It seems a strange warning to me anyway, since sage.graphs is a standard 
module. Sage is seriously defective if it's missing.

On Thursday, 21 September 2023 at 13:57:01 UTC-7 John H Palmieri wrote:

When running Sage, if I look at some docststrings by doing foo.bar?, I see 
at the top

WARNING: the enclosing module is marked 'needs sage.graphs', so doctests 
may not pass.

 


Of course my copy of Sage has (as far as I know!) a working copy of 
sage.graphs. Should this warning only be printed conditionally when the 
module is missing? I took a quick look and didn't see a relevant ticket, 
but I might very well have missed it.

-- 
John

-- 
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 view this discussion on the web visit 
https://groups.google.com/d/msgid/sage-devel/ff945050-ff4f-4be9-ab73-4dd5bb93303an%40googlegroups.com.

Reply via email to