Make help text advice clearer in fieldset guidance #2145
Merged
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
EoinShaughnessy
commented
Apr 20, 2022
✅ You can preview this change here:
To edit notification comments on pull requests, go to your Netlify site settings. |
✅ You can preview this change here:
To edit notification comments on pull requests, go to your Netlify site settings. |
EoinShaughnessy
force-pushed
the
update-fieldset-guidance
branch
from
283a10b to
d417ab3
Compare
dav-idc
approved these changes
Apr 27, 2022
EoinShaughnessy
commented
May 3, 2022
| @@ -31,4 +31,4 @@ Read more about [why and how to set legends as headings](/get-started/labels-leg | |||
|
|
|||
| On [question pages](/patterns/question-pages/) containing a group of inputs, including the question as the legend helps users of screen readers to understand that the inputs are all related to that question. | |||
|
|
|||
| Include any general help text which is important for filling in the form and cannot be written as [hint text](/components/text-input/#hint-text) in the legend, but try to keep it as concise as possible. | |||
| Include general help text in the legend if it would help the user fill in the form, and you cannot write it as [hint text](/components/text-input/#hint-text). However, try to keep it as short as possible. | |||
There was a problem hiding this comment.
@calvin-lau-sig7 Joe commented in the original issue that an example might be good under here. What do you think?
There was a problem hiding this comment.
Hi @joelanman, when you have a chance, can we have a chat so I can understand what the situation for this might be?
There was a problem hiding this comment.
We're going to release, happy to add an example as a further PR.
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.
Fixes #2143.
Current guidance:
This sounds like we're saying users can make help text look like a heading. If that's right, then maybe we should add an example.
Also, the current wording is on the long side, so I had a go at rewriting it.