Clean up informal language in comments and error messages#1190
Merged
Conversation
There was a problem hiding this comment.
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.
1f4912c to
1f041c1
Compare
661f729 to
c7a7e8c
Compare
cb663a5 to
901985c
Compare
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
No description provided.