Skip to content

docs(data modelling): Add data modelling data types to the docs#2637

Open
MortGron wants to merge 3 commits into
masterfrom
data-modelling-data-types-in-docs
Open

docs(data modelling): Add data modelling data types to the docs#2637
MortGron wants to merge 3 commits into
masterfrom
data-modelling-data-types-in-docs

Conversation

@MortGron

Copy link
Copy Markdown
Contributor

Description

There are many references to the data modelling data types classes in the docs, but they have not been documented. Now they are included.

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.

@codecov

codecov Bot commented May 22, 2026

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 93.05%. Comparing base (8f0c3e3) to head (5813eee).

Additional details and impacted files
@@            Coverage Diff             @@
##           master    #2637      +/-   ##
==========================================
- Coverage   93.05%   93.05%   -0.01%     
==========================================
  Files         486      486              
  Lines       49671    49671              
==========================================
- Hits        46221    46219       -2     
- Misses       3450     3452       +2     
Files with missing lines Coverage Δ
cognite/client/_api/diagrams.py 84.26% <ø> (ø)
cognite/client/_sync_api/diagrams.py 91.30% <ø> (ø)

... and 4 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.

@MortGron MortGron marked this pull request as ready for review May 26, 2026 12:48
@MortGron MortGron requested review from a team as code owners May 26, 2026 12:48

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

Copy link
Copy Markdown
Contributor

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 references for FileReference in the diagrams API and adds documentation for data modeling data types. The review feedback points out that referencing contextualization.FileReference directly in the docstrings of DiagramsAPI.detect and SyncDiagramsAPI.detect will cause Sphinx build failures because the contextualization module is not imported in those files. It is recommended to use the fully qualified path cognite.client.data_classes.contextualization.FileReference instead.

Comment thread cognite/client/_api/diagrams.py
Comment thread cognite/client/_sync_api/diagrams.py
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