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

Y24-382: Improve clarity of cherrypicking strategies and values #4544

Open
wants to merge 11 commits into
base: develop
Choose a base branch
from

Conversation

StephenHulme
Copy link
Contributor

@StephenHulme StephenHulme commented Dec 4, 2024

Closes #4412

Changes proposed in this pull request

  • Use Bootstrap 4 instead of tables to fix misleading rendering error of Robot Minimum Volume appearing in wrong column

Before:
Screenshot 2024-12-04 at 12 42 19

After:
Screenshot 2024-12-05 at 12 09 29

Instructions for Reviewers

[All PRs] - Confirm PR template filled
[Feature Branches] - Review code
[Production Merges to main]
    - Check story numbers included
    - Check for debug code
    - Check version

@StephenHulme StephenHulme changed the title Y24-382: make it clear which option belongs to which strategy Y24-382: Improve clarity of cherrypicking strategies and values Dec 5, 2024
Copy link
Contributor

@KatyTaylor KatyTaylor left a comment

Choose a reason for hiding this comment

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

Love the UI improvement, thanks. The misalignment of one of the fields bugged me too. Just asked a few questions.

Copy link
Contributor

Choose a reason for hiding this comment

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

Nice idea to refactor these out into separate files.

Since you're creating them from scratch, I would go for shorter names:

  • cherrypick_by_concentration
  • cherrypick_by_amount
  • cherrypick_by_volume

Easier to read?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Fixed in 208fd63

@@ -0,0 +1,11 @@
<div id='pick_by_nano_grams_per_micro_litre'>

<%= render partial: 'form_group_radio', locals: { field_name: 'cherrypick', category: 'action', field_value: 'nano_grams_per_micro_litre', label_text: 'Pick by concentration (ng/µl)' } %>
Copy link
Contributor

Choose a reason for hiding this comment

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

I was a bit confused by field_name: 'cherrypick', category: 'action', field_value: 'nano_grams_per_micro_litre' so ended up reading the radio_button docs.

Wondering if your form_group_radio and form_group_text components provide much value, or just another layer of abstraction. I think they do - it does make this file easier to read, and saves you from repeating the css.

Maybe a comment somewhere to explain what the field_name, category and field_value are for would help 🤔

Also maybe use 'strategy' instead of 'action'?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Addressed in fb6f7fe and fcf7e69.

I think the original wording was copy-pasted from the documentation example - it should be clearer now.

@@ -0,0 +1,9 @@
<% options ||= {} %>
<% field_id = [field_name, category, field_value].join('_') %>
Copy link
Contributor

Choose a reason for hiding this comment

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

Wondering if there's a more Rails-y way of linking the label to the radio button, so that you don't have to form the id like this?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Good point, eventually found a way, see f472384

app/views/workflows/_cherrypicking_parameters.html.erb Outdated Show resolved Hide resolved
Copy link
Contributor

Choose a reason for hiding this comment

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

I was a bit confused as to what's going on with this one, because the existing file was not being used in the deleted app/views/workflows/_cherrypicking_volume_parameters.html.erb file.

This is modifying a component used in the fluidigm cherrypicking workflow - is this intentional, and tested?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

This is modifying a component used in the fluidigm cherrypicking workflow

This is intentional - but and now tested... (see below).

I realised that this shared common code with the primary cherrypick pipeline. Integrating it to use the same methods and templates as the primary cherrypick code was easier than trying to fix the bugs from different ways of doing the same thing.

Screenshot 2025-01-28 at 14 38 18

@StephenHulme StephenHulme self-assigned this Dec 13, 2024
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.

Y24-382 - Research - updating volume after cherrypicking
2 participants