Skip to content

docs: add all __call__ methods#2633

Open
MortGron wants to merge 2 commits into
masterfrom
add-iteration-methods-to-docs
Open

docs: add all __call__ methods#2633
MortGron wants to merge 2 commits into
masterfrom
add-iteration-methods-to-docs

Conversation

@MortGron
Copy link
Copy Markdown
Contributor

@MortGron MortGron commented May 20, 2026

Description

Add all of the call methods to the documentation

Example:
image

Checklist:

  • Tests added/updated.
  • Documentation updated. Documentation is generated from docstrings - these must be updated according to your change.
    If a new method has been added it should be referenced in cognite.rst in order to generate docs based on its docstring.
  • The PR title follows the Conventional Commit spec.

@MortGron MortGron marked this pull request as ready for review May 20, 2026 15:12
@MortGron MortGron requested review from a team as code owners May 20, 2026 15:12
Copy link
Copy Markdown
Contributor

@gemini-code-assist gemini-code-assist Bot left a comment

Choose a reason for hiding this comment

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

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.

Comment thread docs/source/_templates/custom-automethods-template.rst
Comment thread docs/source/headings.py
Comment thread docs/source/headings.py
Comment thread docs/source/headings.py
@codecov
Copy link
Copy Markdown

codecov Bot commented May 20, 2026

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 93.07%. Comparing base (3326f55) to head (891783c).

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     
Files with missing lines Coverage Δ
cognite/client/_api/datapoints.py 98.50% <ø> (ø)
cognite/client/_sync_api/datapoints.py 100.00% <ø> (ø)

... and 3 files with indirect coverage changes

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
  • 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant