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

Rename 'sample' to 'peak' in auto-reduction code #192

Merged
merged 7 commits into from
Oct 31, 2024
Merged

Conversation

jmborr
Copy link
Member

@jmborr jmborr commented Oct 30, 2024

Description of the changes

Refactored the code to standardize terminology by replacing 'sample' with 'peak' regarding post-processing for
instrument REF_M.

Check all that apply:

  • updated documentation
  • Source added/refactored
  • Added unit tests
  • Added integration tests
  • (If applicable) Verified that manual tests requiring the /SNS and /HFIR filesystems pass without fail

References:

  • Links to IBM EWM items: 7971 (parent 5986)

Manual test for the reviewer

Deploy the app locally:

cd /path/to/data_workflow
conda activate webmon
make clean
make all
make localdev/up

Wait until the docker images are built and services started. Then, point your browser to http://localhost/reduction/ref_m/ and verify reduction settings for the three Peaks are present.

Check list for the reviewer

  • best software practices
    • clearly named variables (better to be verbose in variable names)
    • code comments explaining the intent of code blocks
  • All the tests are passing
  • The documentation is up to date
  • code comments added when explaining intent

Refactored the code to standardize terminology by replacing 'sample' with 'peak'. This change affects variable names, comments, and documentation strings to improve clarity and consistency in the codebase.

Signed-off-by: Jose Borreguero <[email protected]>
@jmborr jmborr self-assigned this Oct 30, 2024
Updated form name from ReductionConfigurationREFMForm to ReductionConfigurationREF_MForm across views and tests to maintain consistency and clarity in naming conventions. Also changed references from "sample" to "peak" for better accuracy in context.

Signed-off-by: Jose Borreguero <[email protected]>
@codecov-commenter
Copy link

codecov-commenter commented Oct 30, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 77.77%. Comparing base (100be00) to head (bc10712).

Additional details and impacted files
@@           Coverage Diff           @@
##             next     #192   +/-   ##
=======================================
  Coverage   77.77%   77.77%           
=======================================
  Files          54       54           
  Lines        4720     4720           
=======================================
  Hits         3671     3671           
  Misses       1049     1049           

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

Renamed the target for creating the conda environment to "create/conda" to align with naming conventions. Also provided an alternative command for creating the environment using mamba.

Signed-off-by: Jose Borreguero <[email protected]>
Enhanced the documentation to give clearer steps on rebuilding wheels. Added instructions to run 'make all' after cleaning existing wheels to ensure complete rebuild.

Signed-off-by: Jose Borreguero <[email protected]>
Commented out the line that writes response content to a file for browser inspection. This change ensures that the code is only executed when debugging, preventing accidental file creation during regular test runs.

Signed-off-by: Jose Borreguero <[email protected]>
Updated the comment to provide clearer instructions on how to inspect the response content using a browser. This change enhances developer clarity when debugging response outputs.

Signed-off-by: Jose Borreguero <[email protected]>
Replaced <span> tags with <label> tags in multiple sections of the configuration_ref_m.html template. This modification ensures better accessibility compliance by clearly linking labels with their corresponding input fields.

Signed-off-by: Jose Borreguero <[email protected]>
@jmborr jmborr requested a review from backmari October 31, 2024 00:00
@backmari
Copy link
Contributor

I deployed locally and the form has been updated to replace "sample" with "peak" and the form allows configuring up to three peaks:
image

Copy link
Contributor

@backmari backmari left a comment

Choose a reason for hiding this comment

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

Looks good!

@jmborr jmborr merged commit 4994a45 into next Oct 31, 2024
4 checks passed
@jmborr jmborr deleted the ref_m_suffix_to_peak branch October 31, 2024 15:30
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