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

Add documentation for each function #56

Open
Delta456 opened this issue Sep 30, 2024 · 4 comments
Open

Add documentation for each function #56

Delta456 opened this issue Sep 30, 2024 · 4 comments
Assignees
@vickywane
Labels
documentation Improvements or additions to documentation good first issue Good for newcomers hacktoberfest Curated issues which are well scoped and ready to be worked on as part of Hacktoberfest

Comments

@Delta456
Copy link
Member

None of the functions used in the project have documentation. The functions need to be documented so that it is easier for users to understand how the code is working.

Inline Documentation Standard will be a good starting point on how to write documentation.
@navin772 navin772 added good first issue Good for newcomers hacktoberfest Curated issues which are well scoped and ready to be worked on as part of Hacktoberfest documentation Improvements or additions to documentation labels Sep 30, 2024
@vickywane
Copy link
Contributor

Hi @navin772 @Delta456

I'd love to work on this issue.

@blissbug
Copy link

Hey! I would like to work on it!

@navin772
Copy link
Member

@vickywane are you working on this? We haven't received any updates or PR from you. If you are not working on it, please unassign yourself.

@vickywane
Copy link
Contributor

Hi @navin772

I;m still working on this and I'll have a PR up soon.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@vickywane vickywane

Labels
documentation Improvements or additions to documentation good first issue Good for newcomers hacktoberfest Curated issues which are well scoped and ready to be worked on as part of Hacktoberfest
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
4 participants
@Delta456 @vickywane @navin772 @blissbug