Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

sage.graphs: Add # optional doctest tags for modularization #35266

Merged
merged 14 commits into from
Apr 1, 2023

Conversation

mkoeppe
Copy link
Contributor

@mkoeppe mkoeppe commented Mar 11, 2023

📚 Description

These tags make it possible/meaningful to doctest sage.graphs even when some "standard" packages (networkx, numpy, the modularized distribution packaging providing sage.groups) are not installed.

📝 Checklist

  • I have made sure that the title is self-explanatory and the description concisely explains the PR.
  • I have linked an issue or discussion.
  • I have created tests covering the changes.
  • I have updated the documentation accordingly.

⌛ Dependencies

This is just one commit on top of:

@codecov-commenter
Copy link

Codecov Report

Patch coverage: 98.07% and project coverage change: +0.01 🎉

Comparison is base (52a81cb) 88.57% compared to head (d90a702) 88.59%.

Additional details and impacted files
@@             Coverage Diff             @@
##           develop   #35266      +/-   ##
===========================================
+ Coverage    88.57%   88.59%   +0.01%     
===========================================
  Files         2140     2141       +1     
  Lines       397273   397416     +143     
===========================================
+ Hits        351891   352085     +194     
+ Misses       45382    45331      -51     
Impacted Files Coverage Δ
src/sage/features/__init__.py 95.18% <ø> (ø)
src/sage/features/all.py 100.00% <ø> (ø)
src/sage/features/bliss.py 100.00% <ø> (ø)
src/sage/features/cddlib.py 100.00% <ø> (ø)
src/sage/features/csdp.py 40.74% <ø> (ø)
src/sage/features/cython.py 100.00% <ø> (ø)
src/sage/features/databases.py 96.15% <ø> (-0.15%) ⬇️
src/sage/features/dvipng.py 100.00% <ø> (ø)
src/sage/features/ffmpeg.py 22.58% <ø> (-2.42%) ⬇️
src/sage/features/gfan.py 100.00% <ø> (ø)
... and 89 more

... and 28 files with indirect coverage changes

Help us with your feedback. Take ten seconds to tell us how you rate us. Have a feature suggestion? Share it here.

☔ View full report in Codecov by Sentry.
📢 Do you have feedback about the report comment? Let us know in this issue.

@dimpase dimpase force-pushed the sage_graphs_optional_tags branch from d90a702 to 5324919 Compare March 14, 2023 09:41
@@ -3409,29 +3409,29 @@ def WheelGraph(n):

Next, using the spring-layout algorithm::

sage: import networkx
sage: import networkx # optional - sage.groups
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

did you mean - networkx here?

Copy link
Member

@dimpase dimpase left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

please check that sage.groups tags are not placed by mistake, instead of networkx

@mkoeppe
Copy link
Contributor Author

mkoeppe commented Mar 14, 2023

Indeed, thanks for catching this

@mkoeppe mkoeppe requested a review from dimpase March 14, 2023 18:23
@mkoeppe mkoeppe force-pushed the sage_graphs_optional_tags branch from f9e8aa0 to b3e5497 Compare March 14, 2023 18:25
@mkoeppe
Copy link
Contributor Author

mkoeppe commented Mar 14, 2023

I've rebased on top of the dependency #35237

Copy link
Member

@dimpase dimpase left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

lgtm

Copy link
Contributor

@dcoudert dcoudert left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM.

src/sage/graphs/generators/families.py Outdated Show resolved Hide resolved
@mkoeppe
Copy link
Contributor Author

mkoeppe commented Mar 14, 2023

Thanks!

@github-actions
Copy link

Documentation preview for this PR is ready! 🎉
Built with commit: b3e5497

@vbraun
Copy link
Member

vbraun commented Mar 29, 2023

sage -t --long --warn-long 73.8 --random-seed=123 src/sage/interfaces/r.py  # 3 doctests failed

@vbraun vbraun merged commit 428b148 into sagemath:develop Apr 1, 2023
@mkoeppe mkoeppe added this to the sage-10.0 milestone Apr 1, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants