Skip to content

chore: re-enabled jsdoc/tag-lines rule, ran lint:fix script to fix linting issues#2066

Merged
BeksOmega merged 2 commits intoRaspberryPiFoundation:masterfrom
sdthaker:Re-enable-the-jsdoc/tag-lines-eslint-rule-#1979
Nov 8, 2023
Merged

chore: re-enabled jsdoc/tag-lines rule, ran lint:fix script to fix linting issues#2066
BeksOmega merged 2 commits intoRaspberryPiFoundation:masterfrom
sdthaker:Re-enable-the-jsdoc/tag-lines-eslint-rule-#1979

Conversation

@sdthaker
Copy link
Contributor

@sdthaker sdthaker commented Nov 8, 2023

The basics

The details

Resolves

Fixes #1979

Proposed Changes

Enforced a recommended blank line rule preceding only the first tag (e.g., @param) in a jsdoc comment.

An Example

Before:

/**
  * Parses XML based on the 'inputs' attribute (non-standard).
  * @param xmlElement XML storage element.
  */

After:

/**
  * Parses XML based on the 'inputs' attribute (non-standard).
  *
  * @param xmlElement XML storage element.
  */

Reason for Changes

Code changes are made for better readability of jsdoc comments.

Test Coverage

N/A

Documentation

N/A

Additional Information

Running npm run lint shows 16 warnings but that's being fixed in #2065.

@sdthaker sdthaker requested a review from a team as a code owner November 8, 2023 14:48
@sdthaker sdthaker requested review from NeilFraser and removed request for a team November 8, 2023 14:48
@BeksOmega BeksOmega assigned BeksOmega and unassigned NeilFraser Nov 8, 2023
@BeksOmega BeksOmega requested review from BeksOmega and removed request for NeilFraser November 8, 2023 16:04
Copy link
Contributor

@BeksOmega BeksOmega left a comment

Choose a reason for hiding this comment

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

This LGTM! Thank you for the fix!

@BeksOmega BeksOmega merged commit 5f62199 into RaspberryPiFoundation:master Nov 8, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Re-enable the jsdoc/tag-lines eslint rule

3 participants