docs(data modelling): Add data modelling data types to the docs#2637
Open
MortGron wants to merge 3 commits into
Open
docs(data modelling): Add data modelling data types to the docs#2637MortGron wants to merge 3 commits into
MortGron wants to merge 3 commits into
Conversation
Codecov Report✅ All modified and coverable lines are covered by tests. 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
🚀 New features to boost your workflow:
|
Contributor
There was a problem hiding this comment.
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.
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
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:
If a new method has been added it should be referenced in cognite.rst in order to generate docs based on its docstring.