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

document inactive param in Button view component #3278

Merged
merged 1 commit into from
Jan 22, 2025

Conversation

ktravers
Copy link
Contributor

@ktravers ktravers commented Jan 17, 2025

Authors: Please fill out this form carefully and completely.

Reviewers: By approving this Pull Request you are approving the code change, as well as its deployment and mitigation plans.
Please read this description carefully. If you feel there is anything unclear or missing, please ask for updates.

What are you trying to accomplish?

While working on https://github.com/github/pull-requests/issues/15457, I noticed that the inactive argument wasn't documented for the Button view component. I added it to the component file here.

Integration

No.

List the issues that this change affects.

Related to https://github.com/github/pull-requests/issues/15457

Risk Assessment

  • Low risk the change is small, highly observable, and easily rolled back.
  • Medium risk changes that are isolated, reduced in scope or could impact few users. The change will not impact library availability.
  • High risk changes are those that could impact customers and SLOs, low or no test coverage, low observability, or slow to rollback.

What approach did you choose and why?

I copied the text from the base button component, which does include this argument. Ideally, we wouldn't have to dupe things in both components, but as far as I can tell, this is currently the only way to do it.

Anything you want to highlight for special attention from reviewers?

Nothing in particular.

Merge checklist

  • Added/updated tests
  • Added/updated documentation
  • Added/updated previews (Lookbook)
  • Tested in Chrome
  • Tested in Firefox
  • Tested in Safari
  • Tested in Edge

Take a look at the What we look for in reviews section of the contributing guidelines for more information on how we review PRs.

@ktravers ktravers self-assigned this Jan 17, 2025
@ktravers ktravers requested a review from a team as a code owner January 17, 2025 16:30
@ktravers ktravers requested a review from TylerJDev January 17, 2025 16:30
Copy link

changeset-bot bot commented Jan 17, 2025

⚠️ No Changeset found

Latest commit: 568c27f

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

@camertron camertron merged commit 376af6c into main Jan 22, 2025
40 of 41 checks passed
@camertron camertron deleted the ktravers/update-button-docs branch January 22, 2025 21:57
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
skip changeset Pull requests that don't change the library output
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants