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

Fixup ert plugin documentation #9013

Merged
merged 1 commit into from
Nov 12, 2024

Conversation

larsevj
Copy link
Contributor

@larsevj larsevj commented Oct 21, 2024

Adds the assumed project structure, and a pyproject.toml example. Also fixes some syntax errors in the code example.

  • PR title captures the intent of the changes, and is fitting for release notes.
  • Added appropriate release note label
  • Commit history is consistent and clean, in line with the contribution guidelines.
  • Make sure unit tests pass locally after every commit (git rebase -i main --exec 'pytest tests/ert/unit_tests -n logical -m "not integration_test"')

When applicable

  • When there are user facing changes: Updated documentation
  • New behavior or changes to existing untested code: Ensured that unit tests are added (See Ground Rules).
  • Large PR: Prepare changes in small commits for more convenient review
  • Bug fix: Add regression test for the bug
  • Bug fix: Create Backport PR to latest release

@larsevj larsevj force-pushed the fix_some_errors_in_ert_plugin_docs branch from bc67cd8 to f003952 Compare October 21, 2024 15:20
@codecov-commenter
Copy link

codecov-commenter commented Oct 21, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 90.71%. Comparing base (f088b4b) to head (5fa37c8).
Report is 3 commits behind head on main.

Additional details and impacted files
@@            Coverage Diff             @@
##             main    #9013      +/-   ##
==========================================
- Coverage   90.79%   90.71%   -0.08%     
==========================================
  Files         352      352              
  Lines       21935    21935              
==========================================
- Hits        19915    19899      -16     
- Misses       2020     2036      +16     
Flag Coverage Δ
cli-tests 39.19% <ø> (-0.07%) ⬇️
gui-tests 71.75% <ø> (-0.03%) ⬇️
performance-tests 49.37% <ø> (+0.01%) ⬆️
unit-tests 79.68% <ø> (-0.01%) ⬇️

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@larsevj larsevj added the release-notes:documentation PR with only changes to documentation label Nov 12, 2024
Copy link
Contributor

@yngve-sk yngve-sk left a comment

Choose a reason for hiding this comment

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

LGTM, nice improvement. Only a small comment

- Specifies package structure assumption
- Adds pyproject.toml example
- Fixes syntax error in code example
@larsevj larsevj force-pushed the fix_some_errors_in_ert_plugin_docs branch from f003952 to 5fa37c8 Compare November 12, 2024 13:58
@larsevj larsevj merged commit 22b7f71 into equinor:main Nov 12, 2024
56 checks passed
@larsevj larsevj deleted the fix_some_errors_in_ert_plugin_docs branch November 12, 2024 14:51
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
release-notes:documentation PR with only changes to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants