-
Notifications
You must be signed in to change notification settings - Fork 24.6k
New issue
Have a question about this project? # for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “#”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? # to your account
Display component methods on the website and tweak the documentation #6890
Display component methods on the website and tweak the documentation #6890
Conversation
By analyzing the blame information on this pull request, we identified @vjeux, @ericvicenti and @sahrens to be potential reviewers. |
@facebook-github-bot shipit |
Thanks for importing. If you are an FB employee go to Phabricator to review. |
@janicduplessis updated the pull request. |
@janicduplessis updated the pull request. |
@janicduplessis updated the pull request. |
@vjeux CI found a few pages that were broken, fixed now. |
@facebook-github-bot shipit |
Thanks for importing. If you are an FB employee go to Phabricator to review. |
Summary:The website now displays public methods on components. This was implemented mostly in react-docgen via facebook#66. This adds a <Method> component that is used by the component and API doc pages to display documentation for a method. It also adds some missing documentation and tweak some existing one to integrate with this feature. I also prefixed some component methods with an '_' so they don't show up in the doc. **Test plan (required)** Tested every component page locally to make sure the methods doc was displayed properly. Tested an API page to make sure it still worked properly. Closes facebook#6890 Differential Revision: D3159911 Pulled By: vjeux fb-gh-sync-id: 1e6a4640cda6794496d9844c1af6a1451c017dcc fbshipit-source-id: 1e6a4640cda6794496d9844c1af6a1451c017dcc
Summary:Oups, forgot to remove a test in facebook#6890 :) Closes facebook#6898 Differential Revision: D3161421 Pulled By: mkonicek fb-gh-sync-id: a7e6b4f31822e67dcf1d898306851a112160d20f fbshipit-source-id: a7e6b4f31822e67dcf1d898306851a112160d20f
The website now displays public methods on components. This was implemented mostly in react-docgen via reactjs/react-docgen#66. This adds a component that is used by the component and API doc pages to display documentation for a method.
It also adds some missing documentation and tweak some existing one to integrate with this feature. I also prefixed some component methods with an '_' so they don't show up in the doc.
Test plan (required)
Tested every component page locally to make sure the methods doc was displayed properly.
Tested an API page to make sure it still worked properly.