On Thursday, June 8, 2023 at 5:11:28 AM UTC-7 kcrisman wrote:

how do you know which modules some random doctest you want to include 
depends on? 


By testing the modularized distributions and looking at the errors and 
backtraces. (I'll expand on this in a separate post.)
This is done in #35095, which currently has about 45000 lines of changes 
compared to upstream/develop.

I also think it might be good to have a style guide 


I have added a bit (on how to reformat doctests and where to put the # 
optional comments) in 
https://deploy-preview-35749--sagemath-tobias.netlify.app/developer/coding_basics.html#writing-testable-examples
 
(this is https://github.com/sagemath/sage/pull/35749).
 

[...] to inform users/developers why a particular optional tag is needed, 
in a comment or something.  For a lot of the optional libraries, that was 
fairly obvious (e.g. if you didn't have Mma or Maple installed, don't do 
those tests, or for the various LP solvers), but maybe that isn't so clear 
now. 


I am adding such information in https://github.com/sagemath/sage/pull/35749 
as well. A first version, explaining # optional - sage.combinat" in detail, 
can be seen in 
https://deploy-preview-35749--sagemath-tobias.netlify.app/reference/misc/sage/features/sagemath.html#sage.features.sagemath.sage__combinat

Comments on the new documentation are very welcome.

-- 
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/cd9be2f5-b63d-4894-8fc6-6d858e5f4bc3n%40googlegroups.com.

Reply via email to