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

Man pages: improve wording of unwinding-related options #8471

Merged
merged 1 commit into from
Sep 25, 2024

Conversation

tautschnig
Copy link
Collaborator

man-page contents for options controlling loop unwinding was particularly terse, with the statement for "partial-loops" not actually helping readers. This is an attempt to remain succinct while still providing meaningful insight.

  • Each commit message has a non-empty body, explaining why the change was made.
  • n/a Methods or procedures I have added are documented, following the guidelines provided in CODING_STANDARD.md.
  • The feature or user visible behaviour I have added or modified has been documented in the User Guide in doc/cprover-manual/
  • n/a Regression or unit tests are included, or existing tests cover the modified code (in this case I have detailed which ones those are in the commit message).
  • n/a My commit message includes data points confirming performance improvements (if claimed).
  • My PR is restricted to a single feature or bugfix.
  • n/a White-space or formatting changes outside the feature-related changed lines are in commits of their own.

Copy link

codecov bot commented Sep 24, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 78.22%. Comparing base (a209b44) to head (36ba12e).
Report is 2 commits behind head on develop.

Additional details and impacted files
@@           Coverage Diff            @@
##           develop    #8471   +/-   ##
========================================
  Coverage    78.22%   78.22%           
========================================
  Files         1726     1726           
  Lines       189038   189038           
  Branches     18265    18265           
========================================
  Hits        147874   147874           
  Misses       41164    41164           

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

@kroening
Copy link
Member

Most people don't know the word "unsound" -- I'd say "may result in false alarms".

man-page contents for options controlling loop unwinding was
particularly terse, with the statement for "partial-loops" not actually
helping readers. This is an attempt to remain succinct while still
providing meaningful insight.
@tautschnig
Copy link
Collaborator Author

Most people don't know the word "unsound" -- I'd say "may result in false alarms".

Indeed, reworded.

@kroening kroening merged commit 4c59d28 into diffblue:develop Sep 25, 2024
38 of 40 checks passed
@tautschnig tautschnig deleted the loops-man-pages branch September 25, 2024 14:56
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