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

[Docs] Annotate callback props with @param tags #3096

Closed
32 of 37 tasks
mbrookes opened this issue Jan 29, 2016 · 3 comments
Closed
32 of 37 tasks

[Docs] Annotate callback props with @param tags #3096

mbrookes opened this issue Jan 29, 2016 · 3 comments
Labels
component: select This is the name of the generic UI component, not the React module! docs Improvements or additions to the documentation umbrella For grouping multiple issues to provide a holistic view

Comments

@mbrookes
Copy link
Member

mbrookes commented Jan 29, 2016

#2841 Added the ability to document the parameters that are passed to callbacks by functions, therefore we need to add that annotation to all public callback properties, following this guide.

Related to #2957.

@oliviertassinari oliviertassinari added the docs Improvements or additions to the documentation label Jan 29, 2016
@alitaheri alitaheri added this to the 0.15.0 Release milestone Jan 30, 2016
@mbrookes mbrookes changed the title [Docs] Annotate signature of function props [Docs] Annotate callback props with @param tags Jan 30, 2016
@mbrookes mbrookes added the umbrella For grouping multiple issues to provide a holistic view label Feb 2, 2016
@mbrookes mbrookes removed the umbrella For grouping multiple issues to provide a holistic view label Feb 5, 2016
@oliviertassinari oliviertassinari added the umbrella For grouping multiple issues to provide a holistic view label Mar 6, 2016
@oliviertassinari oliviertassinari modified the milestones: 0.15.0 Release, 0.16.0 Release Mar 6, 2016
@miclaus
Copy link

miclaus commented Dec 10, 2016

+1

In search for Sliders onChange callback params.

@mbrookes
Copy link
Member Author

Use the source Luke. (And feel free to submit a PR).

@miclaus
Copy link

miclaus commented Dec 18, 2016

@mbrookes PR #5804 should care for TextField

@oliviertassinari oliviertassinari added the component: select This is the name of the generic UI component, not the React module! label Mar 26, 2017
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
component: select This is the name of the generic UI component, not the React module! docs Improvements or additions to the documentation umbrella For grouping multiple issues to provide a holistic view
Projects
None yet
Development

No branches or pull requests

4 participants