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.

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

USWDS - Core: Update comment style for SASS functions #5217

Open
2 tasks done
mejiaj opened this issue Apr 7, 2023 · 0 comments
Open
2 tasks done

USWDS - Core: Update comment style for SASS functions #5217

mejiaj opened this issue Apr 7, 2023 · 0 comments
Labels
Affects: Documentation Relates to documentation. Should this be in uswds-site? Context: Sass Issue is in Sass Role: Dev Development/engineering skills needed Type: Enhancement An improvement to existing code

Comments

@mejiaj
Copy link
Contributor

mejiaj commented Apr 7, 2023

Is your feature request related to a problem? Please describe.

Use documentation comments instead of CSS style comments to prevent them from being included in compiled CSS.

Example of commented code seen on compile
#5209

Describe the solution you'd like

For example:

- /*
- ========================================
- General-purpose functions
- ----------------------------------------
- */


+ // ==========================================================================
+ // General-purpose functions
+ // ==========================================================================
- /* ln()
- ----------------------------------------
- */

+ //
+ // ln()
+ // ==========================================================================
+
+ /// Computes an exponent.
+ ///
+ /// @param {number} $value
+ ///   The exponent.
+ /// @return {number} `$value` to the power of 10.

Describe alternatives you've considered

No response

Additional context

Following this style will make it easier to integrate sassdoc.
https://sass-lang.com/documentation/syntax/comments#documentation-comments

Related issue:
#2642

Code of Conduct

@mejiaj mejiaj added Type: Feature Request New functionality Affects: Documentation Relates to documentation. Should this be in uswds-site? Context: Sass Issue is in Sass Status: Triage We're triaging this issue and grooming if necessary labels Apr 7, 2023
@mejiaj mejiaj changed the title USWDS - Core: Update comment style for SASS mixins and functions USWDS - Core: Update comment style for SASS functions Apr 7, 2023
@thisisdano thisisdano added Role: Dev Development/engineering skills needed Type: Enhancement An improvement to existing code and removed Status: Triage We're triaging this issue and grooming if necessary Type: Feature Request New functionality labels Jun 1, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Affects: Documentation Relates to documentation. Should this be in uswds-site? Context: Sass Issue is in Sass Role: Dev Development/engineering skills needed Type: Enhancement An improvement to existing code
Projects
Status: Ready to Schedule
Development

No branches or pull requests

2 participants