Skip to content

📝 Add naming conventions for limit variables in documentation#3590

Merged
chris-ashe merged 1 commit intomainfrom
variable_min_max_naming
Mar 17, 2025
Merged

📝 Add naming conventions for limit variables in documentation#3590
chris-ashe merged 1 commit intomainfrom
variable_min_max_naming

Conversation

@chris-ashe
Copy link
Copy Markdown
Collaborator

This pull request includes a small change to the documentation/proc-pages/development/standards.md file. The change adds a note on naming conventions for limit variables, specifying the use of _max, _min, and _peak in variable names.

Checklist

I confirm that I have completed the following checks:

  • My changes follow the PROCESS style guide
  • I have justified any large differences in the regression tests caused by this pull request in the comments.
  • I have added new tests where appropriate for the changes I have made.
  • If I have had to change any existing unit or integration tests, I have justified this change in the pull request comments.
  • If I have made documentation changes, I have checked they render correctly.
  • I have added documentation for my change, if appropriate.

@chris-ashe chris-ashe added the Documentation Improvements or additions to documentation label Mar 17, 2025
@chris-ashe chris-ashe self-assigned this Mar 17, 2025
@chris-ashe chris-ashe requested a review from jonmaddock March 17, 2025 11:30
@codecov-commenter
Copy link
Copy Markdown

codecov-commenter commented Mar 17, 2025

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 31.20%. Comparing base (ecf30f1) to head (4921d0b).
⚠️ Report is 465 commits behind head on main.

Additional details and impacted files
@@           Coverage Diff           @@
##             main    #3590   +/-   ##
=======================================
  Coverage   31.20%   31.20%           
=======================================
  Files          83       83           
  Lines       19943    19943           
=======================================
  Hits         6223     6223           
  Misses      13720    13720           

☔ View full report in Codecov by Sentry.
📢 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.

@chris-ashe chris-ashe merged commit 2c230dd into main Mar 17, 2025
@chris-ashe chris-ashe deleted the variable_min_max_naming branch March 17, 2025 15:16
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

None yet

Development

Successfully merging this pull request may close these issues.

3 participants