Skip to content

Conversation

@jnjosh
Copy link
Collaborator

@jnjosh jnjosh commented Oct 24, 2025

Description

Updates doc files for help-text, combobox, and radio-group to properly show examples of using negative help text. This also shows the correct behavior in examples (see screenshots below).

Related issue(s)

  • fixes SWC-1088

Screenshots (if appropriate)

Before
before

After
after


Author's checklist

  • I have read the CONTRIBUTING and PULL_REQUESTS documents.
  • I have reviewed at the Accessibility Practices for this feature, see: Aria Practices
  • I have added automated tests to cover my changes.
  • I have included a well-written changeset if my change needs to be published.
  • I have included updated documentation if my change required it.

Reviewer's checklist

  • Includes a Github Issue with appropriate flag or Jira ticket number without a link
  • Includes thoughtfully written changeset if changes suggested include patch, minor, or major features
  • Automated tests cover all use cases and follow best practices for writing
  • Validated on all supported browsers
  • All VRTs are approved before the author can update Golden Hash

Manual review test cases

Documentation Quality

  • All files follow template structure with proper collapsible sections
  • Summary sections are concise and actionable
  • No broken markdown syntax

@jnjosh jnjosh self-assigned this Oct 24, 2025
@jnjosh jnjosh requested a review from a team as a code owner October 24, 2025 21:18
@changeset-bot
Copy link

changeset-bot bot commented Oct 24, 2025

⚠️ No Changeset found

Latest commit: 7db870a

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

@github-actions
Copy link
Contributor

github-actions bot commented Oct 24, 2025

📚 Branch Preview

🔍 Visual Regression Test Results

When a visual regression test fails (or has previously failed while working on this branch), its results can be found in the following URLs:

Deployed to Azure Blob Storage: pr-5828

If the changes are expected, update the current_golden_images_cache hash in the circleci config to accept the new images. Instructions are included in that file.
If the changes are unexpected, you can investigate the cause of the differences and update the code accordingly.

@github-actions
Copy link
Contributor

Tachometer results

Currently, no packages are changed by this PR...

@coveralls
Copy link
Collaborator

coveralls commented Oct 24, 2025

Pull Request Test Coverage Report for Build 18841796323

Details

  • 0 of 0 changed or added relevant lines in 0 files are covered.
  • No unchanged relevant lines lost coverage.
  • Overall coverage remained the same at 97.966%

Totals Coverage Status
Change from base Build 18841047631: 0.0%
Covered Lines: 34259
Relevant Lines: 34788

💛 - Coveralls

@jnjosh jnjosh added Documentation Issues or PRs involving changes to documentation or documentation website Status: Ready for review PR ready for review or re-review. labels Oct 24, 2025
Copy link
Contributor

@caseyisonit caseyisonit left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

OMG ITS GLORIOUS

- An overall description of an input field or controls
- Hints for what kind of information needs to be inputted or selected
- Specific formatting examples or requirements
- An overall description of an input field or controls
Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This must have been a lint change, but I think it's right, so I left it. Happy to revert if folks think this is incorrect.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

we have linting issues between different users i think, its something we've always accepted but should be more perscriptive in second-gen

@jnjosh jnjosh merged commit c568a7e into main Oct 27, 2025
27 checks passed
@jnjosh jnjosh deleted the jnjosh/SWC-1088 branch October 27, 2025 14:36
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Documentation Issues or PRs involving changes to documentation or documentation website Status: Ready for review PR ready for review or re-review.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

6 participants