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

add inactive argument to Button view component docs #3276

Closed
wants to merge 3 commits into from

Conversation

ktravers
Copy link
Contributor

@ktravers ktravers commented Jan 16, 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.

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 16, 2025
@ktravers ktravers requested a review from a team as a code owner January 16, 2025 22:08
@ktravers ktravers requested a review from joshblack January 16, 2025 22:08
Copy link

changeset-bot bot commented Jan 16, 2025

⚠️ No Changeset found

Latest commit: 410834a

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.

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

Copy link
Contributor

⚠️ Visual or Semantic markup differences found

Our visual and semantic markup comparison tests found UI differences. Please review the differences by viewing the files changed tab to ensure that the changes were intentional.

Review differences

@github-actions github-actions bot requested a review from a team as a code owner January 16, 2025 22:21
@github-actions github-actions bot requested a review from langermank January 16, 2025 22:21
@ktravers
Copy link
Contributor Author

Uhhh... no idea what's going on with the addition of 973 component snapshot files. My changes didn't touch the UI. I added one code comment to one file 😬

@khiga8
Copy link
Contributor

khiga8 commented Jan 17, 2025

Hi @ktravers! We were working out some VRT weirdness but that should now be fixed per #3273.

If you drop the auto-generated commit, another fresh check will kick off, and hopefully this should be resolved!

@ktravers ktravers requested a review from a team as a code owner January 17, 2025 16:20
@ktravers
Copy link
Contributor Author

Yikes... I pushed a revert commit, and the files changed count more than doubled 😬

I'll try dropping instead of reverting. If that doesn't do anything, I guess I'll open a new PR.

@ktravers
Copy link
Contributor Author

Yeah, something's up with the git history, so I wasn't able to drop the snapshot commits. Closing in favor of #3278

@ktravers ktravers closed this Jan 17, 2025
@ktravers ktravers deleted the ktravers-patch-1 branch January 26, 2025 20:40
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