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

Request: Improved comments/docs #3

Open
SimmonsRitchie opened this issue Sep 7, 2021 · 0 comments
Open

Request: Improved comments/docs #3

SimmonsRitchie opened this issue Sep 7, 2021 · 0 comments
Labels
documentation Improvements or additions to documentation

Comments

@SimmonsRitchie
Copy link

SimmonsRitchie commented Sep 7, 2021

The folks in Texas would be super appreciative if some docstrings could be added to a number of the funcs in this repo (eg. getSpecialNav) 🙏

I'm just finding it a bit difficult to understand exactly why certain args are required in certain funcs. Docstrings would be super helpful.

I'd suggest JSDoc style. Eg.:

 * Takes 2 numbers and returns their sum.
 * @param   {number} a the first number
 * @param   {number} b the second number
 *
 * @returns {number} the sum of a and b
 */
function addNumbers(a, b) {
  return a + b;
}
@SimmonsRitchie SimmonsRitchie added the documentation Improvements or additions to documentation label Sep 7, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

1 participant