Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

DOC: Add data/content docstrings #726

Merged
merged 2 commits into from
Jul 3, 2024
Merged

DOC: Add data/content docstrings #726

merged 2 commits into from
Jul 3, 2024

Conversation

mferrera
Copy link
Collaborator

@mferrera mferrera commented Jul 3, 2024

Works more toward #696.

@mferrera mferrera marked this pull request as ready for review July 3, 2024 07:55
@mferrera mferrera self-assigned this Jul 3, 2024
@mferrera mferrera force-pushed the even-more-docstrings branch 3 times, most recently from 9aad9e5 to 38e85bb Compare July 3, 2024 10:32
@mferrera mferrera requested a review from jcrivenaes July 3, 2024 10:34
jcrivenaes
jcrivenaes reviewed Jul 3, 2024
View reviewed changes
src/fmu/dataio/datastructure/meta/content.py
@@ -180,228 +177,435 @@ class BoundingBox3D(BoundingBox2D):
)


class Content(BaseModel):
content: enums.ContentEnum = Field(description="The contents of this data object")
class Data(BaseModel):
Copy link
Collaborator

Choose a reason for hiding this comment

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

🚀

jcrivenaes
jcrivenaes approved these changes Jul 3, 2024
View reviewed changes
Copy link
Collaborator

@jcrivenaes jcrivenaes left a comment

Choose a reason for hiding this comment

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

Great work

mferrera added 2 commits July 3, 2024 15:29
@mferrera
MAINT: Remove unused metadata class
9473208
@mferrera
DOC: Add data/content docstrings
b8d7d70 
Also contains some minor fixes to the items in `meta.py`.
@mferrera mferrera force-pushed the even-more-docstrings branch from 38e85bb to b8d7d70 Compare July 3, 2024 13:29
@mferrera mferrera merged commit 6263e89 into equinor:main Jul 3, 2024
13 checks passed
@mferrera mferrera deleted the even-more-docstrings branch July 3, 2024 13:37
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@jcrivenaes jcrivenaes jcrivenaes approved these changes

@tnatt tnatt Awaiting requested review from tnatt

@perolavsvendsen perolavsvendsen Awaiting requested review from perolavsvendsen

Assignees

@mferrera mferrera

Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@mferrera @jcrivenaes @perolavsvendsen