-
Notifications
You must be signed in to change notification settings - Fork 336
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
Clarify docs for all nested options #3919
Conversation
90fb00a
to
ee51999
Compare
We may still want to bring back "dot-prefix" nested object names for readability: |
ee51999
to
29ef234
Compare
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Raised a few suggestions, mainly to try and avoid having multiple 'If x
is set' in the same description.
Noticed we're using multiple words to describe when an option is set ('set', 'provided', 'supplied'…) – standardised on 'provided' for now just so we're at least consistent when describing a single option.
Have also added a card to the Trello board to try and address more fully: https://trello.com/c/HvWJ2GMc/20-we-talk-about-options-being-set-provided-supplied-specified-sometimes-within-the-same-description
packages/govuk-frontend/src/govuk/components/summary-list/summary-list.yaml
Show resolved
Hide resolved
packages/govuk-frontend/src/govuk/components/summary-list/summary-list.yaml
Show resolved
Hide resolved
packages/govuk-frontend/src/govuk/components/summary-list/summary-list.yaml
Show resolved
Hide resolved
packages/govuk-frontend/src/govuk/components/summary-list/summary-list.yaml
Show resolved
Hide resolved
packages/govuk-frontend/src/govuk/components/summary-list/summary-list.yaml
Show resolved
Hide resolved
packages/govuk-frontend/src/govuk/components/summary-list/summary-list.yaml
Show resolved
Hide resolved
This change follows the newer content pattern used by Task List options
29ef234
to
6233797
Compare
Rebased with latest |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Looking good, thanks for tidying those up 🙌🏻 @claireashworth do you want to have a quick look maybe before we merge this in as it's mostly content related? 😊
Thanks @romaricpascal @claireashworth I've pulled together the same "format" used in both #3878 and #3902 description: If `html` is set, this is not required. The ${child} of each ${parent}. ${description}. If `html` is provided, the `text` option will be ignored. It's wordy, repetitive, but what we use the most at the moment We should do a follow up once the Design System Nunjucks docs issues Trello board has been reviewed |
I noticed last week that we sometimes "dot-prefix" nested option names with the associated parent or component
The Prototype Kit team are looking into generating documentation from component
macro-options.json
so this change copies what we did for Radios and Checkboxesconditional
to structure all nested options correctlyAccordion
,heading.text
→heading.html
heading
,summary.text
→summary.html
summary
,content.text
→content.html
content
Summary list
,key.text
→key.html
key
,value.text
→value.html
value
,actions.text
→actions.html
actions
Like other nested options, these now show as separate tables (with links) on the Design System website: