Skip to content

Add miscellaneous missing docs - #960

Merged
mtorpey merged 20 commits into
digraphs:mainfrom
William-Kenyon:misc-missing-docs
Nov 5, 2026
Merged

mtorpey merged 20 commits into
digraphs:mainfrom
William-Kenyon:misc-missing-docs

Conversation

@William-Kenyon

Copy link
Copy Markdown
Collaborator

I used a small script to find instances where Declare...("name", ...) existed but had no corresponding mansection, i.e. no <Oper/Attr/Prop/... name="name" ...>, and updated the docs where appropriate. Excluding ...Cons, ...NC, DIGRAPHS_... etc.

@codecov

codecov Bot commented Oct 25, 2026 •

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 97.47%. Comparing base (9529aae) to head (b61bed0).
⚠️ Report is 3 commits behind head on main.

Additional details and impacted files
@@            Coverage Diff             @@
##             main     #960      +/-   ##
==========================================
- Coverage   97.48%   97.47%   -0.01%     
==========================================
  Files          53       53              
  Lines       21363    21424      +61     
  Branches      639      638       -1     
==========================================
+ Hits        20825    20883      +58     
- Misses        473      477       +4     
+ Partials       65       64       -1     

☔ View full report in Codecov by Harness.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

@james-d-mitchell james-d-mitchell left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

A couple of minor TODOs, then we'll be happy to merge, thanks @William-Kenyon this is super helpful!

Comment thread doc/grahom.xml Resolved
Comment thread doc/weights.xml Resolved
Comment thread doc/weights.xml Resolved
Comment thread doc/weights.xml Resolved
@james-d-mitchell james-d-mitchell added the doc Issues, bugs, pull requests relating to the documentation label Oct 26, 2026
Comment thread doc/weights.xml Resolved
Comment thread doc/weights.xml Resolved
Comment thread gap/weights.gi Resolved
Comment thread gap/weights.gi Resolved
Comment thread doc/weights.xml Resolved
Comment thread gap/weights.gi Resolved
Co-authored-by: James Mitchell <james-d-mitchell@users.noreply.github.com>

@james-d-mitchell james-d-mitchell left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Looks good to me @mtorpey can you also have a wee look?

@mtorpey mtorpey left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

One tiny improvement to be made, along with the comma in the failing test. After that, let's merge!

Comment thread gap/weights.gd Outdated
Comment on lines +13 to +16
DeclareOperation("EdgeWeightedDigraph",
[IsDigraph and IsMutableDigraph, IsList]);
DeclareOperation("EdgeWeightedDigraph",
[IsDigraph and IsImmutableDigraph, IsList]);

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

This can be just one operation, with [IsDigraph, IsList] as the filter.

@mtorpey
mtorpey merged commit eb7aef7 into digraphs:main Nov 5, 2026
28 checks passed
@William-Kenyon
William-Kenyon deleted the misc-missing-docs branch November 5, 2026 16:28
@William-Kenyon William-Kenyon added the VIP Pull requests done by participants of the VIP programme. label Nov 14, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

doc Issues, bugs, pull requests relating to the documentation VIP Pull requests done by participants of the VIP programme.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants