Repository navigation
Add miscellaneous missing docs - #960
William-Kenyon wants to merge 13 commits into
Conversation
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #960 +/- ##
=======================================
Coverage 97.48% 97.48%
=======================================
Files 53 53
Lines 21363 21368 +5
Branches 639 639
=======================================
+ Hits 20825 20830 +5
Misses 473 473
Partials 65 65 ☔ View full report in Codecov by Harness. 🚀 New features to boost your workflow:
|
james-d-mitchell
left a comment
james-d-mitchell
left a comment
There was a problem hiding this comment.
A couple of minor TODOs, then we'll be happy to merge, thanks @William-Kenyon this is super helpful!
There was a problem hiding this comment.
There seems to be a TODO:
gap/grahom.gd:45:DeclareAttribute("DigraphSmallestLastOrder", IsDigraph); # TODO: document
which you could also delete.
| <Description> | ||
| <C>UnitEdgeWeightedDigraph</C> returns an edge-weighted copy of | ||
| <A>digraph</A>, with all edge weights set to 1.<P/> | ||
|
|
There was a problem hiding this comment.
There should be a statement about what happens when digraph is mutable/immutable here.
There was a problem hiding this comment.
Thanks @William-Kenyon, re-reading this now makes me think that we should only install this method for immutable digraphs, so that a "no method found" error is given for mutable digraphs. The reason being that the current behaviour is pretty astonishing, i.e. will non-obviously not do what's you might reasonably expect.
| <Prop Name="IsNegativeEdgeWeightedDigraph" Arg="digraph"/> | ||
| <Returns>A boolean.</Returns> | ||
| <Description> | ||
| This returns <C>true</C> if <A>digraph</A> contains at least one edge |
There was a problem hiding this comment.
| This returns <C>true</C> if <A>digraph</A> contains at least one edge | |
| This returns <K>true</K> if <A>digraph</A> contains at least one edge |
K for "keyword"
james-d-mitchell
added
the
doc
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.