Skip to content

Fix small issues in everest docs#12598

Merged
SAKavli merged 2 commits intoequinor:mainfrom
SAKavli:fix-everest-documentation
Jan 12, 2026
Merged

Fix small issues in everest docs#12598
SAKavli merged 2 commits intoequinor:mainfrom
SAKavli:fix-everest-documentation

Conversation

@SAKavli
Copy link
Contributor

@SAKavli SAKavli commented Jan 8, 2026

Am reading the documentation, so I will fix any issues I find along the way.

This will be squashed.

@codecov-commenter
Copy link

codecov-commenter commented Jan 8, 2026

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 90.52%. Comparing base (589e079) to head (018361a).
⚠️ Report is 22 commits behind head on main.

Additional details and impacted files
@@            Coverage Diff             @@
##             main   #12598      +/-   ##
==========================================
- Coverage   90.56%   90.52%   -0.04%     
==========================================
  Files         435      435              
  Lines       29977    30014      +37     
==========================================
+ Hits        27148    27171      +23     
- Misses       2829     2843      +14     
Flag Coverage Δ
cli-tests 37.27% <ø> (-0.15%) ⬇️
gui-tests 68.71% <ø> (+0.09%) ⬆️
performance-and-unit-tests 73.88% <ø> (-0.07%) ⬇️
test 38.05% <ø> (-0.05%) ⬇️

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.

@SAKavli SAKavli force-pushed the fix-everest-documentation branch from 83f4206 to 04ad43a Compare January 8, 2026 08:50
@SAKavli SAKavli force-pushed the fix-everest-documentation branch from 04ad43a to 047743d Compare January 8, 2026 09:32
@SAKavli SAKavli added this to SCOUT Jan 8, 2026
@SAKavli SAKavli moved this to In Progress in SCOUT Jan 8, 2026
@SAKavli SAKavli force-pushed the fix-everest-documentation branch from 047743d to c9d50c8 Compare January 8, 2026 10:40
@codspeed-hq
Copy link

codspeed-hq bot commented Jan 8, 2026

CodSpeed Performance Report

Merging this PR will not alter performance

Comparing SAKavli:fix-everest-documentation (018361a) with main (87e6aa7)

Summary

✅ 22 untouched benchmarks

@SAKavli SAKavli self-assigned this Jan 8, 2026
@SAKavli SAKavli changed the title Fix small issues in everest introduction doc Fix small issues in everest docs Jan 8, 2026
@berland
Copy link
Contributor

berland commented Jan 8, 2026

Even though Equinor officially should write British English, we are possibly beyond the point where we can change back from optimization to optimization, as for realization - (realization has become the de-facto FMU standard). I don't know if TNO has any preference for british vs americal English.

@SAKavli SAKavli force-pushed the fix-everest-documentation branch from f482d56 to 7f625f2 Compare January 9, 2026 13:12
@SAKavli
Copy link
Contributor Author

SAKavli commented Jan 9, 2026

I thought it was a good idea to improve the docs while I went through it, but perhaps I've caused enough ruccus and should leave it as is more or less, before something breaks.

@berland
Copy link
Contributor

berland commented Jan 9, 2026

I'd say use "optimization" everywhere for consistency, and keep your other fixes, they are valuable!

@SAKavli SAKavli moved this from In Progress to Ready for Review in SCOUT Jan 12, 2026
@SAKavli SAKavli moved this from Ready for Review to In Progress in SCOUT Jan 12, 2026
@SAKavli SAKavli force-pushed the fix-everest-documentation branch 3 times, most recently from 2a515f9 to 0896c14 Compare January 12, 2026 08:47
@SAKavli SAKavli moved this from In Progress to Ready for Review in SCOUT Jan 12, 2026
@SAKavli SAKavli requested a review from berland January 12, 2026 08:54
Copy link
Contributor

@berland berland left a comment

Choose a reason for hiding this comment

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

LGTM!

@github-project-automation github-project-automation bot moved this from Ready for Review to Reviewed in SCOUT Jan 12, 2026
@berland
Copy link
Contributor

berland commented Jan 12, 2026

Squash all or selectively?

@SAKavli
Copy link
Contributor Author

SAKavli commented Jan 12, 2026

Most commits touch the same lines - as they were huge, aka merge conflicts. Squashing all would save that headache. Can keep newlines as a separate commit to make the grammatical changes more readable.

@SAKavli SAKavli force-pushed the fix-everest-documentation branch from 0896c14 to 99bd0c5 Compare January 12, 2026 11:53
An -> A data assimilation

Consistently write realization

Replace model definition "ensemble of models"
with "ensemble of realiations"

Take away -> takeaways

Consistently captialize Everest in text

Use optimize with z consistently
@SAKavli SAKavli force-pushed the fix-everest-documentation branch from 99bd0c5 to 018361a Compare January 12, 2026 11:58
@SAKavli SAKavli added the release-notes:documentation PR with only changes to documentation label Jan 12, 2026
@SAKavli SAKavli merged commit 58c219b into equinor:main Jan 12, 2026
36 checks passed
@github-project-automation github-project-automation bot moved this from Reviewed to Done in SCOUT Jan 12, 2026
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

Archived in project

Development

Successfully merging this pull request may close these issues.

3 participants