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

HELP : (Documentation ) Adding JSDoc comments to the methods #58

Open
wenayy opened this issue Oct 8, 2024 · 3 comments
Open

HELP : (Documentation ) Adding JSDoc comments to the methods #58

wenayy opened this issue Oct 8, 2024 · 3 comments
Assignees
@wenayy
Labels
documentation Improvements or additions to documentation good first issue Good for newcomers hacktoberfest help wanted Extra attention is needed

Comments

@wenayy
Copy link

wenayy commented Oct 8, 2024

Adding JSDoc comments to your methods is a great way to enhance the documentation of your code, making it easier for others (and yourself) to understand how to use your methods, what parameters they accept, and what they return.
@IntegerAlex IntegerAlex added documentation Improvements or additions to documentation help wanted Extra attention is needed hacktoberfest labels Oct 8, 2024
@IntegerAlex IntegerAlex changed the title Documentation: Consider adding JSDoc comments to the methods HELP : (Documentation ) Adding JSDoc comments to the methods Oct 8, 2024
@IntegerAlex
Copy link
Owner

Yes, I am writing unit tests, I will add JSDoc.

@wenayy
Copy link
Author

wenayy commented Oct 9, 2024

can I help

@IntegerAlex
Copy link
Owner

Wait for my setup PR, then
Yes i am assigning you, Create PR/MR per file not big changes.

@IntegerAlex IntegerAlex added the good first issue Good for newcomers label Oct 11, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@wenayy wenayy

Labels
documentation Improvements or additions to documentation good first issue Good for newcomers hacktoberfest help wanted Extra attention is needed
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
2 participants
@IntegerAlex @wenayy