1209 feature add jsdoc linter #1210
Open
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
![sourcery-ai[bot]](https://avatars.githubusercontent.com/in/48477?s=60&v=4){kind=small}
There was a problem hiding this comment.
We failed to fetch the diff for pull request #1210
You can try again by commenting this pull request with @sourcery-ai review, or contact us for help.
JoshuaSBrown
added
Type: Refactor
1211 fix jsdoc errors
t-ramz
reviewed
Jan 7, 2025
AronPerez
reviewed
Jan 8, 2025
Remove nested docs.
t-ramz
reviewed
Jan 13, 2025
| * output: ['usr', 'local', 'bin', 'node'] | ||
| * @throws {Error} If the provided path is not a valid string. | ||
| * | ||
| * @example |
There was a problem hiding this comment.
Should this example show usage as well? e.g. const splitPath = splitPOSIXPath(posixPath);
t-ramz
reviewed
Jan 13, 2025
t-ramz
reviewed
Jan 13, 2025
|
|
||
| module.exports = [ | ||
| { | ||
| ignores: ["docs/_static/**/*", "web/static/jquery/jquery.js", "web/node_modules"], |
There was a problem hiding this comment.
Will this also run on build for the Foxx API?
There was a problem hiding this comment.
It runs for everything in the repo? Are you worried about a node_modules file in the foxx api? I don't think that will happen because foxx installs in the database not locally on the filesystem.
t-ramz
reviewed
Jan 13, 2025
| @@ -3188,9 +3189,12 @@ module.exports = (function () { | |||
| }; | |||
|
|
|||
| /** | |||
| * Parses other_token_data string field and breaks it into pieces | |||
| * | |||
| * @param {integer} token_type - Type to determine parse logic. | |||
There was a problem hiding this comment.
It didn't like my typing? 😢
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.
PR Description
Adding jsdoc linter will help to keep code changes consistent between developers and limit the intellectual overhead of seeing white space changes in the source code. This PR fixes the problem by using a formatter and a linter to help with code quality.
Tasks