docs: add all __call__ methods#2633
Open
MortGron wants to merge 2 commits into
Open
Conversation
Contributor
There was a problem hiding this comment.
Code Review
This pull request updates the documentation generation logic to include __call__ methods for various SDK resources, allowing them to be properly documented in the API reference. Key changes include modifications to the autosummary extension and templates, as well as adding descriptive headings for these methods across numerous client modules. Feedback identifies a potential duplication of the __call__ method in the generated documentation and highlights several instances of inconsistent capitalization in the resource descriptions that should be corrected for consistency.
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## master #2633 +/- ##
==========================================
- Coverage 93.10% 93.07% -0.03%
==========================================
Files 486 486
Lines 49633 49633
==========================================
- Hits 46210 46196 -14
- Misses 3423 3437 +14
🚀 New features to boost your workflow:
|
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
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.
Description
Add all of the call methods to the documentation
Example:

Checklist:
If a new method has been added it should be referenced in cognite.rst in order to generate docs based on its docstring.