USWDS - Utilities: Update inaccurate comments

[amyleadem]

Summary

Updated the code comments on utility Sass partials. These comments now reflect the correct utility class names and values.

Important

This PR builds on the changes added by @aduth in PR #5700. Thank you @aduth!

Breaking change

This is not a breaking change. This update only affects code comments.

Related issue

Closes #5860

Related pull requests

This PR builds on the changes from @aduth in PR #5700.

Preview link

N/A

Problem statement

The code comments on the files in the packages/uswds-utilities/src/styles/rules/ directory are outdated and inaccurate. These code comments should be updated so that developers can use the code comments as reference (especially for utilities not documented on our website).

Solution

This PR updates outdate utility class references to match uswds 3.0 naming conventions.

Testing and review

1. Confirm that all files in the packages/uswds-utilities/src/styles/rules/ have comments that reflect current USWDS naming structures
2. Confirm comments are formatted consistently

[mejiaj]

Thanks for making these fixes. I was able to test comments are accurate and up-to-date.

Can we fix the closing } in the code examples?

[mejiaj]

Tip

Not alphabetical order, but it's output in uswds.css.

/* uswds.css */
.add-list-reset{
  margin-bottom:0;
  margin-top:0;
  padding-left:0;
  list-style:none;
}

[mejiaj]

What's the value of the *?

[amyleadem]

I believe it indicates that the modifier is optional. At least, that is my assumption based on the other comments with this format. I read it as the class can can be written as .overflow-hidden or .overflow-y-hidden.

[mahoneycm]

This is looking great, thank you for combing through these and updating.

Besides James' new line comment, I noticed a space missing for one value. Minuscule change but might as well while we're here 😄

[amyleadem]

@mejiaj and @mahoneycm Thanks for those comments. I've moved the closing braces in the comments to a new line to meet standards and added the missing space to the opacity comment. Please let me know if I missed anything!

[thisisdano]

Thanks @aduth and @amyleadem! A somewhat thankless but important task

[thisisdano]

But now it's thankless no longer :)