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

Files in src need proper documentation #224

Closed
c3ho opened this issue Nov 15, 2019 · 2 comments
Closed

Files in src need proper documentation #224

c3ho opened this issue Nov 15, 2019 · 2 comments
Labels
type: discussion Requires conversation type: documentation (docs) Improvements or additions to documentation

Comments

@c3ho
Copy link
Contributor

c3ho commented Nov 15, 2019

I noticed some of the source files(including mine) are missing proper documentation, such as comments describing the functions , parameters and what it returns.

There are a few good examples in the src directory at the moment, such as email-sender.js, github-url.js we could use as an example. I suggest we pick one of the two and use it as a standard going forward.

@c3ho c3ho added type: discussion Requires conversation type: documentation (docs) Improvements or additions to documentation labels Nov 15, 2019
@evlnyng evlnyng self-assigned this Nov 21, 2019
@Seneca-CDOT Seneca-CDOT deleted a comment Dec 15, 2019
@Seneca-CDOT Seneca-CDOT deleted a comment from mrmojorisin92 Dec 15, 2019
@agarcia-caicedo agarcia-caicedo assigned c3ho and unassigned evlnyng Jan 13, 2020
@c3ho c3ho removed their assignment Jan 26, 2020
@c3ho
Copy link
Contributor Author

c3ho commented Mar 2, 2020

Closing this issue as it is too vague.

@c3ho c3ho closed this as completed Mar 2, 2020
@alexjones999
Copy link

Could you please guide me how can I do the required modifications or changes as per you. So that I can do that and implement.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
type: discussion Requires conversation type: documentation (docs) Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

3 participants