Skip to content

Escape backslashes in RST doc strings - #883

Merged
berland merged 1 commit into
equinor:mainfrom
berland:fix_rst_issues
Sep 1, 2026
Merged

Escape backslashes in RST doc strings#883
berland merged 1 commit into
equinor:mainfrom
berland:fix_rst_issues

Conversation

@berland

@berland berland commented Aug 28, 2026

Copy link
Copy Markdown
Collaborator

The unescaped backslashes were interpreted by RST while rendering, which was not the intention. Also remove a poorly rendered caption that reads better without it.

@berland berland self-assigned this Aug 28, 2026
@berland berland added the documentation Improvements or additions to documentation label Aug 28, 2026
The unescaped backslashes were interpreted by RST while rendering, which was not the
intention. Also remove a poorly rendered caption that reads better without it.
@codecov-commenter

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 84.28%. Comparing base (284c256) to head (a998227).

Additional details and impacted files
@@           Coverage Diff           @@
##             main     #883   +/-   ##
=======================================
  Coverage   84.28%   84.28%           
=======================================
  Files          49       49           
  Lines        7528     7528           
=======================================
  Hits         6345     6345           
  Misses       1183     1183           

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

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

@berland berland added this to SCOUT Aug 31, 2026
@berland berland moved this to Ready for Review in SCOUT Aug 31, 2026
::

GEN_DATA DPDT_SIM INPUT_FORMAT:ASCII REPORT_STEPS:1
GEN_DATA DPDT_SIM INPUT_FORMAT:ASCII REPORT_STEPS:1 \\

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Is it needed here as well?

Copy link
Copy Markdown
Collaborator Author

Choose a reason for hiding this comment

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

Yes, here it was missing altogheter and the syntax was plain wrong, as RESULT_FILE is an option to GEN_DATA

@eilskra eilskra 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.

🚀

@github-project-automation github-project-automation Bot moved this from Ready for Review to Reviewed in SCOUT Sep 1, 2026
@berland
berland merged commit dcec041 into equinor:main Sep 1, 2026
7 checks passed
@github-project-automation github-project-automation Bot moved this from Reviewed to Done in SCOUT Sep 1, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

Status: Done

Development

Successfully merging this pull request may close these issues.

3 participants