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

InlineParameterEditor: fix it being impossible to write '0.001' #3123

Merged

Conversation

Williangalvani
Copy link
Member

@Williangalvani Williangalvani commented Feb 5, 2025

v-model.number attempts to convert number too eagerly. this fixes it

Summary by Sourcery

Bug Fixes:

  • Fix the inability to enter small numerical values, such as "0.001", in the inline parameter editor.

Copy link

sourcery-ai bot commented Feb 5, 2025

Reviewer's Guide by Sourcery

The pull request modifies the InlineParameterEditor component to correctly handle numerical inputs, specifically addressing an issue where writing small decimal values like '0.001' was not possible due to eager conversion. It introduces a new variable to manage the input as a string, parsing it to a float upon input.

Sequence diagram for number input handling in InlineParameterEditor

sequenceDiagram
    actor User
    participant Input as Number Input Field
    participant Component as InlineParameterEditor

User->>Input: Types '0.001'
Input->>Component: @input event
Component->>Component: parseFloat(internal_new_value_as_string)
Note right of Component: Converts string to number
Component->>Component: Updates internal_new_value
Loading

State diagram for number input handling

stateDiagram-v2
    [*] --> StringInput: User types number
    StringInput --> NumberValue: parseFloat()
    NumberValue --> ValidatedValue: Range & Type validation
    ValidatedValue --> [*]: Update parameter
Loading

File-Level Changes

Change Details Files
Introduced a new variable to handle the input value as a string.
  • Added internal_new_value_as_string to data.
  • Initialized internal_new_value_as_string in the param watcher.
core/frontend/src/components/parameter-editor/InlineParameterEditor.vue
Modified the v-model binding to use the new string variable.
  • Replaced v-model.number with v-model and internal_new_value_as_string.
  • Added an @input handler to parse the string to a float and update internal_new_value.
core/frontend/src/components/parameter-editor/InlineParameterEditor.vue

Tips and commands

Interacting with Sourcery

  • Trigger a new review: Comment @sourcery-ai review on the pull request.
  • Continue discussions: Reply directly to Sourcery's review comments.
  • Generate a GitHub issue from a review comment: Ask Sourcery to create an
    issue from a review comment by replying to it. You can also reply to a
    review comment with @sourcery-ai issue to create an issue from it.
  • Generate a pull request title: Write @sourcery-ai anywhere in the pull
    request title to generate a title at any time. You can also comment
    @sourcery-ai title on the pull request to (re-)generate the title at any time.
  • Generate a pull request summary: Write @sourcery-ai summary anywhere in
    the pull request body to generate a PR summary at any time exactly where you
    want it. You can also comment @sourcery-ai summary on the pull request to
    (re-)generate the summary at any time.
  • Generate reviewer's guide: Comment @sourcery-ai guide on the pull
    request to (re-)generate the reviewer's guide at any time.
  • Resolve all Sourcery comments: Comment @sourcery-ai resolve on the
    pull request to resolve all Sourcery comments. Useful if you've already
    addressed all the comments and don't want to see them anymore.
  • Dismiss all Sourcery reviews: Comment @sourcery-ai dismiss on the pull
    request to dismiss all existing Sourcery reviews. Especially useful if you
    want to start fresh with a new review - don't forget to comment
    @sourcery-ai review to trigger a new review!
  • Generate a plan of action for an issue: Comment @sourcery-ai plan on
    an issue to generate a plan of action for it.

Customizing Your Experience

Access your dashboard to:

  • Enable or disable review features such as the Sourcery-generated pull request
    summary, the reviewer's guide, and others.
  • Change the review language.
  • Add, remove or edit custom review instructions.
  • Adjust other review settings.

Getting Help

Copy link

@sourcery-ai sourcery-ai bot left a comment

Choose a reason for hiding this comment

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

Hey @Williangalvani - I've reviewed your changes and they look great!

Here's what I looked at during the review
  • 🟢 General issues: all looks good
  • 🟢 Security: all looks good
  • 🟢 Testing: all looks good
  • 🟢 Complexity: all looks good
  • 🟢 Documentation: all looks good

Sourcery is free for open source - if you like our reviews please consider sharing them ✨
Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.

@patrickelectric patrickelectric merged commit 3685af2 into bluerobotics:master Feb 5, 2025
6 checks passed
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.

2 participants