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

[Documentation Missing] Add JSDoc #13

Open
vinitshahdeo opened this issue Oct 11, 2019 · 1 comment
Open

[Documentation Missing] Add JSDoc #13

vinitshahdeo opened this issue Oct 11, 2019 · 1 comment
Labels
documentation Add JSDoc good first issue Good for newcomers hacktoberfest help wanted Extra attention is needed up-for-grabs Solve the issue and raise your first PR

Comments

@vinitshahdeo
Copy link
Owner

There are many functions in background.js which are using chrome.cookies API. Adding a short description before each function will make the code more readable.

For example,

/*
 *
 * @description event listener which notifies whenever cookie's properties are updated
 */
function onCookieChanged(){
  chrome.cookies.onChanged.addListener(function(cookies){
      console.log("cookies are being changed ", cookies.cookie.domain);
      console.log(cookies);
  });
}
  • Add JSDoc for each function.
  • Do not make any changes to other files.
  • Write assumptions if any.

Please refer to JSDoc and chrome.cookies API.

@vinitshahdeo vinitshahdeo added good first issue Good for newcomers hacktoberfest help wanted Extra attention is needed up-for-grabs Solve the issue and raise your first PR documentation Add JSDoc labels Oct 11, 2019
@hotdang-ca
Copy link

Happy to grab this one.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Add JSDoc good first issue Good for newcomers hacktoberfest help wanted Extra attention is needed up-for-grabs Solve the issue and raise your first PR
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants