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

Radio - Ensure Consistency between Storybook Documentation and Codebase Property Names #823

Closed
4 of 5 tasks
angelicahoyss opened this issue Jan 23, 2024 · 6 comments · Fixed by #962
Closed
4 of 5 tasks
Assignees
Labels
⭕ core team issue This is for the core team and should not be done by contributors ⌨️ dev issue Task is for developers 🎓 junior issue Good for juniors

Comments

@angelicahoyss
Copy link
Contributor

angelicahoyss commented Jan 23, 2024

Prerequisite

#824 is done and closed
#521 is done and closed

Description / User Story

As a developer on the team,
I want to ensure consistency between the property names defined in the Storybook documentation for Radio component
So that the Radio component codebase accurately reflects the documented property names.

This user story outlines the need to maintain consistency between the documentation and the codebase regarding component property names. Each component is checked to ensure the property names in the codebase match the corresponding names in the Storybook documentation. If the discrepancies are found, they are listed in this table on the page "Radio". Column Current Code Property Name describes how is the property currently named in the code. Column Desired Code Property Name is how the property should be named. Properties marked green don't need adjustment.


Acceptance Criteria

  • All Radio component's property names that differ from Storybook documentation property names (listed in the above mentioned table) should be updated
  • The updated property names should not introduce any unintended side effects or issues in the functionality of the components
  • "araiaLabel" should be renamed to ariaLabel in Storybook file (Documentation)
  • The library builds successfully, and there are no reported issues related to the property name updates
  • Props Excel has been updated / comments have been resolved and props changed from red to black font color > @thrbnhrtmnn or @angelicahoyss can support here
@angelicahoyss angelicahoyss added this to the Prop alignment milestone Jan 23, 2024
@angelicahoyss angelicahoyss added 🎓 junior issue Good for juniors ⌨️ dev issue Task is for developers ⭕ core team issue This is for the core team and should not be done by contributors labels Jan 23, 2024
@angelicahoyss angelicahoyss self-assigned this Jan 23, 2024
@thrbnhrtmnn
Copy link
Contributor

Hey @angelicahoyss , I think you copy pasted the description from the checkbox issue, right? Checkbox was mentioned a few times in the user story in the description. I changed it now to "Radio".

@angelicahoyss
Copy link
Contributor Author

Sorry @thrbnhrtmnn I thought I replaced it! Thank you :)

@bar-tay bar-tay self-assigned this Feb 23, 2024
@bar-tay
Copy link
Contributor

bar-tay commented Feb 27, 2024

@thrbnhrtmnn I don't think the value prop is needed since we already use the label prop to manipulate the text

@thrbnhrtmnn
Copy link
Contributor

Hey @bar-tay , you can ignore the value prop for now, as it has its own ticket: #824 .

We should discuss in a refinement session, if this change is really needed.

@bar-tay
Copy link
Contributor

bar-tay commented Mar 22, 2024

Hey @bar-tay , you can ignore the value prop for now, as it has its own ticket: #824 .

We should discuss in a refinement session, if this change is really needed.

Did we decide on what to do about the value prop?

@thrbnhrtmnn
Copy link
Contributor

@bar-tay , no, not yet. But should still be able to do this ticket, just ignore the value prop for now. Last time i checked the PR it already looked good, but I was waiting for a dev to also have a look and approve before I would look again and approve

faselbaum added a commit that referenced this issue Apr 4, 2024
…#962)

Co-authored-by: Barkley <[email protected]>
Co-authored-by: Julius Walther <[email protected]>
Co-authored-by: David Kennedy <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
⭕ core team issue This is for the core team and should not be done by contributors ⌨️ dev issue Task is for developers 🎓 junior issue Good for juniors
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants