USWDS-Site - Settings: Fix code audit issues #2016
Merged
Conversation
This file contains hidden or 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
added 21 commits
February 27, 2023 15:23
…dit-settings-fix
amyleadem
commented
Mar 7, 2023
Comment on lines
+54
to
+58
| {% for type in setting.type %} | ||
| <span class="margin-bottom-05"> | ||
| {% include get-token-url.html token=type %} | ||
| </span> | ||
| {% endfor %} |
Advertisement
There was a problem hiding this comment.
This allows for multiple token types to be declared. Useful for tokens like $theme-collection-header-typeset that need to declare three different tokens in one setting.
amyleadem
commented
Mar 7, 2023
Comment on lines
-90
to
+97
| {% include get-token-url.html token=entry.kind %} | ||
| {% include get-token-url.html token=entry.type %} | ||
| </span> | ||
| </td> | ||
| <td data-title="{{ col5Title }}" class="{{ col5Width }} display-inline-flex flex-align-start"> | ||
| <span class="font-lang-3xs"> | ||
| {{ entry.usage | markdownify }} | ||
| {{ entry.description | markdownify }} |
Advertisement
There was a problem hiding this comment.
This fixes the broken token types on mapped items.
mahoneycm
approved these changes
Mar 8, 2023
amyleadem
changed the title
thisisdano
approved these changes
Mar 20, 2023
mejiaj
reviewed
Mar 20, 2023
mejiaj
approved these changes
Mar 20, 2023
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.
Summary
Resolved inconsistencies with what is found in USWDS.
Related issue
Closes #2009
Preview link
Preview link: Settings page
Problem statement
The code documentation audit revealed several inconsistencies with the settings in USWDS 3.3.0.
Individual issues have been itemized in the Code documentation audit spreadsheet (Google sheets) 🔒
Solution
Update settings documentation to accurately reflect what is in the current version USWDS.
⚠️ This does not include any changes included in the forthcoming 3.4.0 release.
Tasks completed
settings.ymlsince it doesn't appear to be used.settings-table.htmlto show types in mapssettings-table.htmlto show token types when multiple token types are usedOutstanding questions
$theme-prose-font-familybe moved to the components section?[token name],[token value]line from$[utility-module]-manual-values?Testing and review