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.

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

Feature/documentation update #349

Merged
merged 4 commits into from
Oct 18, 2024
Merged

Feature/documentation update #349

merged 4 commits into from
Oct 18, 2024

Conversation

rwiker
Copy link
Contributor

@rwiker rwiker commented Oct 18, 2024

Issue

N/A

Short description

  • Added docstrings to metrics aggregations.
  • Updated module documentation (explorer.rst)

Pre-review checklist

  • Read through all changes. No redundant print() statements, commented-out code, or other remnants from the development. 👀
  • Make sure tests pass after every commit. ✅
  • New/refactored code is following same conventions as the rest of the code base. 🧬
  • New/refactored code is tested. ⚙
  • Documentation has been updated 🧾

Pre-merge checklist

  • Commit history is consistent and clean. 👌

Raymond Wiker added 3 commits October 17, 2024 14:53
… so that the value is availble directly, instead of through the 'value'/'values' key of a dict.
@rwiker rwiker requested a review from a team October 18, 2024 09:40
equinor-ruaj
equinor-ruaj previously approved these changes Oct 18, 2024
Copy link
Contributor

@equinor-ruaj equinor-ruaj left a comment

Choose a reason for hiding this comment

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

lgtm 📜

sumo = Explorer()
help(explorer.filter)

Note that this full set of filters may not make sense for all objetcs;
Copy link
Contributor

Choose a reason for hiding this comment

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

typo in "objects"

Copy link
Contributor

@equinor-ruaj equinor-ruaj left a comment

Choose a reason for hiding this comment

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

👍

@rwiker rwiker merged commit 688d8b1 into main Oct 18, 2024
25 checks passed
@rwiker rwiker deleted the feature/documentation-update branch October 18, 2024 12:11
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.

2 participants