-
Notifications
You must be signed in to change notification settings - Fork 298
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
[all] updating components with tsdocs comments to properties, additio… #125
Conversation
…nally only people picker has function comments
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Couple notes:
- Now that we've merged the tslint pr, it should help define which properties, methods, classes, etc need documentation.
- I've noticed you are not documenting classes, enums, etc - make sure you do those as well - tslint should help here (things like private properties and methods are not required for example)
- I've notices you are not documenting all the providers and graph source files, need to make sure everything is documented. If that's the case, ensure you've made that clear in this PR so we ensure we track other source files that need tsdocs
…aph/microsoft-graph-toolkit into nivogt/tsdocs-update
@nmetulev please re-review, I'll merge after bug fixes for people-picker |
This PR is only documenting the components and that's ok as we are updating the other source files in other PRs. Created #133 to track the rest of the work. Once you have resolved this last one comment, we can merge this |
#125) * [all] updating components with tsdocs comments to properties, additionally only people picker has function comments * [mgt-agenda] updating tsdocs * [mgt-login] updating tsdocs * [people] updating ts docs * [people-picker] updating tsdocs * [mgt-person] updating tsdocs * [mgt-tasks] updating tsdocs * [mgt-login] additional ts documentation
#125) * [all] updating components with tsdocs comments to properties, additionally only people picker has function comments * [mgt-agenda] updating tsdocs * [mgt-login] updating tsdocs * [people] updating ts docs * [people-picker] updating tsdocs * [mgt-person] updating tsdocs * [mgt-tasks] updating tsdocs * [mgt-login] additional ts documentation
#125) * [all] updating components with tsdocs comments to properties, additionally only people picker has function comments * [mgt-agenda] updating tsdocs * [mgt-login] updating tsdocs * [people] updating ts docs * [people-picker] updating tsdocs * [mgt-person] updating tsdocs * [mgt-tasks] updating tsdocs * [mgt-login] additional ts documentation
…nally only people picker has function comments
PR Type
Refactoring (no functional changes, no api changes)
Documentation content changes
Description of the changes
Adding tsdocs comments to all component properties.
Referencing #115:
PR checklist
Other information