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.

Sign up for GitHub

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

Jump to bottom

Adapt the comments in JSDoc format (in utils.ts) #299

Open
carma12 opened this issue Mar 1, 2024 · 0 comments
Open

Adapt the comments in JSDoc format (in utils.ts) #299

carma12 opened this issue Mar 1, 2024 · 0 comments
Labels
enhancement New feature or request good first issue Good for newcomers

Comments

@carma12
Copy link
Collaborator

carma12 commented Mar 1, 2024

The comments in the utils.ts file should be adapted into JSDoc format. This way, its description can be seen when it is used anywhere and this functionality is compatible with many IDEs.
image

E.g.,
Instead of:

// Here is a description
// Two lines have been added

Do:

/*
* Here is a description
* Two lines have been added 
*/
@carma12 carma12 added enhancement New feature or request good first issue Good for newcomers labels Mar 1, 2024
@carma12 carma12 mentioned this issue Mar 1, 2024
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
enhancement New feature or request good first issue Good for newcomers
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@carma12