API reference: detect missing class pages & populate all gaps - #416
Merged
sadielbartholomew merged 8 commits intoAug 3, 2026
Merged
Conversation
sadielbartholomew
added
the
documentation
davidhassell
approved these changes
Aug 3, 2026
davidhassell
left a comment
davidhassell
left a comment
Contributor
There was a problem hiding this comment.
Hi Sadie - the method and execution all look good to me (I've built the docs to have a look). Please merge when you're ready.
Member
Author
|
Thanks for the review David. Noting that the linting CI job is failing for unrelated reasons (some required services are down), merging. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Sister PR to NCAS-CMS/cf-python#959, doing the equivalent thing for cfdm, namely detecting undocumented classes in the
docs/source/check_docs_api_coverage.pylogic and adding in any missing pages and associated methods. There were 33 (of 77 total, at present) missing in this case!Note as with the cf-python PR I haven't, for the newly-documented, previously missing classes, organised their methods under sub-headings, because this will take quite a lot of time and I think it is better we get them into the documented first and then we can think about organising them later. For now I've bunged them all under a 'methods' heading and they are in ASCIIbetical order from copying and pasting from the checking script output.