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

Standardise Blur module code comments #1342

Closed
harshkhandeparkar opened this issue Dec 9, 2019 · 1 comment · Fixed by #1347
Closed

Standardise Blur module code comments #1342

harshkhandeparkar opened this issue Dec 9, 2019 · 1 comment · Fixed by #1347
Labels
documentation gci-candidate Issue being considered for gci

Comments

@harshkhandeparkar
Copy link
Member

Note: We are preparing to participate in Google Code-in, and have reserved this issue for participants in GCI - but we'd love to have your help with another one! Please check out https://code.publiclab.org to see more.

This is a sub-issue of #1046

The comments in the following files are inconsistent:

  1. Blur.js
  2. Module.js

Rules:

  1. Methods must be described using JSDoc comments
  2. Misc code comments should be inline unless it is a long sentence.
  3. No use of continuous tenses, no pronouns.
  4. No redundant comments.
  5. Each comment should start with an uppercase letter and end with a full stop.
@harshkhandeparkar harshkhandeparkar added documentation gci-candidate Issue being considered for gci labels Dec 9, 2019
@harshkhandeparkar
Copy link
Member Author

I have already claimed this issue.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation gci-candidate Issue being considered for gci
Projects
None yet
Development

Successfully merging a pull request may close this issue.

1 participant