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.

Sign up for GitHub

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

Make help text advice clearer in fieldset guidance #2145

Merged
merged 1 commit into from
May 6, 2022
Merged

Make help text advice clearer in fieldset guidance #2145

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions src/components/fieldset/index.md.njk
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
title: Fieldset
description: Use the fieldset component to group related form inputs
section: Components
aliases:
aliases:
backlog_issue_id: 48
layout: layout-pane.njk
---
Expand Down Expand Up @@ -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.
Copy link
Contributor Author

Choose a reason for hiding this comment

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

@calvin-lau-sig7 Joe commented in the original issue that an example might be good under here. What do you think?

Copy link
Contributor

Choose a reason for hiding this comment

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

Hi @joelanman, when you have a chance, can we have a chat so I can understand what the situation for this might be?

Copy link
Contributor

Choose a reason for hiding this comment

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

We're going to release, happy to add an example as a further PR.