Skip to content

Clean up informal language in comments and error messages#1190

Merged
eivindjahren merged 2 commits into
mainfrom
fix_docs
Jun 12, 2026
Merged

Clean up informal language in comments and error messages#1190
eivindjahren merged 2 commits into
mainfrom
fix_docs

Conversation

@eivindjahren

Copy link
Copy Markdown
Collaborator

No description provided.

Copilot AI left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Pull request overview

This PR focuses on making comments, docstrings, and user-facing messages more professional and readable across the Python and C/C++ portions of the resdata codebase.

Changes:

  • Corrects spelling/grammar in multiple docstrings and inline comments.
  • Rewords some comments/error messages to remove informal language (e.g., “uber-hack”, “belly up”, “automagically”).
  • Tweaks wording for clarity in documentation blocks describing file formats and APIs.

Reviewed changes

Copilot reviewed 13 out of 13 changed files in this pull request and generated 2 comments.

Show a summary per file
File Description
python/resdata/summary/rd_sum.py Fixes typos and clarifies several docstrings/error messages in summary utilities.
python/resdata/resfile/rd_file.py Rewords an inline comment in report date handling to be less informal.
python/resdata/resfile/fortio.py Improves module/class docstrings (but currently introduces a wrong source-file reference; see comment).
python/resdata/grid/rd_grid.py Cleans up docstrings and removes informal phrasing in grid APIs.
lib/util/vector_template.cpp.in Fixes spelling in a template comment.
lib/util/util.cpp Rewords a comment to replace “hack” with “workaround”.
lib/util/test_work_area.cpp Makes the example path/name more neutral.
lib/util/node_data.cpp Rewords a comment (but currently understates that the code aborts; see comment).
lib/resdata/rd_util.cpp Cleans up informal comment wording.
lib/resdata/rd_smspec.cpp Improves clarity and tone in a multi-line explanatory comment.
lib/resdata/rd_kw_grdecl.cpp Removes informal emphasis in a comment about parsing robustness.
lib/resdata/rd_grav.cpp Makes stderr output more professional/neutral.
lib/resdata/rd_file_view.cpp Fixes typos and improves clarity in a large explanatory comment block.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Comment thread python/resdata/resfile/fortio.py Outdated
Comment thread lib/util/node_data.cpp
@eivindjahren eivindjahren force-pushed the fix_docs branch 2 times, most recently from 1f4912c to 1f041c1 Compare June 12, 2026 05:45

@berland berland left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

😍

@eivindjahren eivindjahren changed the title docs: clean up informal language in comments and error messages Clean up informal language in comments and error messages Jun 12, 2026
@eivindjahren eivindjahren force-pushed the fix_docs branch 2 times, most recently from 661f729 to c7a7e8c Compare June 12, 2026 06:13
@eivindjahren eivindjahren force-pushed the fix_docs branch 2 times, most recently from cb663a5 to 901985c Compare June 12, 2026 06:49
@eivindjahren eivindjahren merged commit b541b57 into main Jun 12, 2026
12 checks passed
@eivindjahren eivindjahren deleted the fix_docs branch June 12, 2026 07:24
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.

3 participants