Fix JSDOC's lint description and type issues #1278
Merged
Conversation
This file contains 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
Previous work #1269 Building on from previous work of using eslint to handle out code conventions this change will use the auto fix feature of eslint and fix any errors relating to a jsoc description not having a - to separate and also fix any types that are incorrectly named i.e Object shoudl dbe object. Some of the more complex changes such as adding returns and parameters to the jsdocs will be left to be done as when the file is touched or when time permits addressing tech debt.
Previous work #1269 Building on from previous work of using eslint to handle out code conventions this change will use the auto fix feature of eslint and fix any errors relating to a jsoc description not having a - to separate and also fix any types that are incorrectly named i.e Object shoudl dbe object. Some of the more complex changes such as adding returns and parameters to the jsdocs will be left to be done as when the file is touched or when time permits addressing tech debt.
jonathangoulding
added
the
housekeeping
Cruikshanks
requested changes
Aug 21, 2024
Co-authored-by: Alan Cruikshanks <[email protected]>
…c-description # Conflicts: # app/services/plugins/hapi-pino-ignore-request.service.js
Cruikshanks
approved these changes
Aug 21, 2024
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.
DEFRA/water-abstraction-team#125
Building on from previous work of using eslint to handle out code conventions this change will use the auto fix feature of eslint and fix any errors relating to a jsoc description not having a - to separate and also fix any types that are incorrectly named i.e Object shoudl dbe object.
Some of the more complex changes such as adding returns and parameters to the jsdocs will be left to be done as when the file is touched or when time permits addressing tech debt.