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

Mark all optional params correctly within JSDoc comments #321

Open
1 task
benjamincharity opened this issue Jul 26, 2019 · 0 comments
Open
1 task

Mark all optional params correctly within JSDoc comments #321

benjamincharity opened this issue Jul 26, 2019 · 0 comments
Labels
Goal: Library Stabilization A task needed to get the library closer to it's final state Type: chore Something that needs to be done but is not a bug or addition

Comments

@benjamincharity
Copy link
Contributor

Currently our JSDoc comments do not explicitly mark optional params. We should add this for clarity.

  • Mark all optional params by wrapping the param name in curly brackets:
// Existing
/**
 * Dispatches a keydown event from an element.
 *
 * @param type - The event type
 * @param key - The KeyCode type
 * @param target - The target element
 * @return The event
 *
 * @example
 * createKeyboardEvent('keydown', ENTER, myInputNativeElement);
 */

// After change:
/**
 * Dispatches a keydown event from an element.
 *
 * @param type - The event type
 * @param key - The KeyCode type
 * @param {target} - The target element
 * @return The event
 *
 * @example
 * createKeyboardEvent('keydown', ENTER, myInputNativeElement);
 */
@benjamincharity benjamincharity added Goal: Library Stabilization A task needed to get the library closer to it's final state Type: chore Something that needs to be done but is not a bug or addition labels Jul 26, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Goal: Library Stabilization A task needed to get the library closer to it's final state Type: chore Something that needs to be done but is not a bug or addition
Projects
None yet
Development

No branches or pull requests

1 participant