Enhance battery.json : Improve consistency in descriptions and naming #76567
+3
−3
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
- Added "This one can't be recharged." to the description of the light battery cell to match the format of the ultra-light battery versions. - Added " (rechargeable)" to the medium battery cell name for clarity, aligning with the pattern of ultra-light and light versions. - Added a comma to the rechargeable ultra-light battery cell for consistency with the non-rechargeable version.
github-actions
bot
added
[JSON]
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Summary
Bugfixes "Ensure consistency in battery cell descriptions and naming"
Purpose of change
This change aims to improve consistency in the naming and descriptions of Light and Medium battery cells within the JSON file. The goal is to make the descriptions and names more intuitive and uniform.
The name and description of "ultra-light battery" makes it clear whether the one you have is rechargeable or not. Awesome.
The "light battery" description, however, does not clarify that it is non-rechargeable the same way ultra-light does. This is not an issue except when the following point comes into play.
The "medium battery" name and description does not mention whether it is rechargeable or not.
So i would normally not try to recharge it if i came across the ultra-light version first because i would wait to find the "medium battery (rechargeable)"
By aligning the descriptions for rechargeable and non-rechargeable batteries, the changes reduce confusion and make the battery types easier to understand and use.
Describe the solution
Light Battery Cell: Added "This one can't be recharged." to the description to align it with the ultra-light battery cells, which already specify whether they are rechargeable or not.
Medium Battery Cell: Updated the name by adding " (rechargeable)" to make it clear this battery is rechargeable, despite not having a non-rechargeable counterpart. This ensures consistency with the naming patterns of ultra-light and light battery cells.
Ultra-Light Rechargeable Battery Cell: Added a missing comma in the description to ensure consistency with the non-rechargeable version. A tiny fix.
Describe alternatives you've considered
Remove "This one can't be recharged" from all descriptions and keep the clarification only in the item names across all three battery types. This would make the rechargeable status more apparent at a glance when viewing the item name. However, the "medium" battery does not have a non-rechargeable version, and if you don't see a (rechargeable) version you might think what you have is rechargeable just like before the batteries got changed.
Testing
No tests conducted, the file change was made on the Github website.
Additional context