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

Fix JSDOC's lint required params and returns #1279

Merged
merged 10 commits into from
Aug 22, 2024

Conversation

jonathangoulding
Copy link
Collaborator

@jonathangoulding jonathangoulding commented Aug 21, 2024

DEFRA/water-abstraction-team#125

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 required paramas and returns for private methods.

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 required paramas and returns for private methods.

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 jonathangoulding self-assigned this Aug 21, 2024
@Cruikshanks
Copy link
Member

Does this help you @jonathangoulding ? #1280

@jonathangoulding
Copy link
Collaborator Author

Does this help you @jonathangoulding ? #1280

That'll do it for the params.

@jonathangoulding jonathangoulding marked this pull request as ready for review August 21, 2024 14:50
@jonathangoulding jonathangoulding added the housekeeping Refactoring, tidying up or other work which supports the project label Aug 21, 2024
@jonathangoulding jonathangoulding merged commit 50d254b into main Aug 22, 2024
6 checks passed
@jonathangoulding jonathangoulding deleted the fix-jsdoc-required-params-and-returns branch August 22, 2024 07:46
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
housekeeping Refactoring, tidying up or other work which supports the project
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants