BlueOS icon indicating copy to clipboard operation
BlueOS copied to clipboard

Minor language corrections

Open ES-Alexander opened this issue 8 months ago • 2 comments

Corrections and improvements discovered while creating bluerobotics/BlueOS-docs#53

Summary by Sourcery

Make minor language and spelling corrections across various frontend components

Bug Fixes:

  • Fix typos in method names and user-facing text

Enhancements:

  • Improve text clarity and grammar in user interface messages

ES-Alexander avatar Apr 14 '25 17:04 ES-Alexander

Reviewer's Guide by Sourcery

This pull request includes minor language corrections and improvements across various frontend components. The changes focus on enhancing clarity, fixing typos, and improving grammar in user-facing text and instructions within the vehicle setup configuration.

No diagrams generated as the changes look simple and do not need a visual representation.

File-Level Changes

Change Details Files
Corrected and improved the language used in the ArduPilot compass setup instructions, enhancing clarity and accuracy.
  • Improved descriptions for full, quick, and log-based compass calibrations.
  • Clarified the process and requirements for compass learning.
  • Updated instructions for changing compass order and usage.
  • Corrected a typo in the compass calibration status description.
core/frontend/src/components/vehiclesetup/configuration/compass/ArdupilotMavlinkCompassSetup.vue
Improved the language used in the camera configuration component, focusing on clarity and user guidance.
  • Updated the message for unsupported firmware versions.
  • Clarified instructions for finding servo limits and measuring rotation angles.
  • Corrected a unit symbol for PWM/degree ratio.
core/frontend/src/components/vehiclesetup/configuration/camera.vue
Refined the language in the full compass calibrator component for better user understanding.
  • Improved the description of onboard compass calibration.
  • Clarified the recommendation for a valid position during calibration.
core/frontend/src/components/vehiclesetup/configuration/compass/FullCompassCalibrator.vue
Improved the language used in the network interface priority menu, focusing on clarity and user guidance.
  • Clarified the instructions for changing network access priority.
  • Improved the text for checking internet access status.
  • Updated the success message after updating interface priorities.
core/frontend/src/components/app/NetworkInterfacePriorityMenu.vue
Improved the language used in the compass learning component, focusing on clarity and user guidance.
  • Clarified the requirement for a valid position during compass learning.
  • Improved the instructions for driving the vehicle during compass learning.
core/frontend/src/components/vehiclesetup/configuration/compass/CompassLearn.vue
Improved the language used in the lights configuration component, focusing on clarity and user guidance.
  • Improved the descriptions for configuring light output pins.
  • Clarified the explanation of joystick steps and brightness increase.
core/frontend/src/components/vehiclesetup/configuration/lights.vue
Fixed a typo in method names related to loading annotations in the generic viewer component.
  • Corrected the spelling of 'annotations' in method names.
  • Ensured consistent naming for loading annotation overrides.
core/frontend/src/components/vehiclesetup/viewers/GenericViewer.vue
Improved the language used in the large vehicle compass calibrator component, focusing on clarity and user guidance.
  • Clarified the requirement for a valid position during compass calibration.
core/frontend/src/components/vehiclesetup/configuration/compass/LargeVehicleCompassCalibrator.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!

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

  • Contact our support team for questions or feedback.
  • Visit our documentation for detailed guides and information.
  • Keep in touch with the Sourcery team by following us on X/Twitter, LinkedIn or GitHub.

sourcery-ai[bot] avatar Apr 14 '25 17:04 sourcery-ai[bot]

Still intending to do some corrections to the compass calibration page, and possibly some of the other vehicle setup pages too.

ES-Alexander avatar Apr 15 '25 22:04 ES-Alexander

@Williangalvani could you check the compass updates? :-)

I'm unsure whether the log-based calibration description is too long, or whether it's ok given the content it's currently covering.

ES-Alexander avatar Apr 24 '25 06:04 ES-Alexander