-
Notifications
You must be signed in to change notification settings - Fork 289
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
Update api docs (beta) #485
Update api docs (beta) #485
Conversation
* remove 0.6 migration guide * remove 0.5 api docs * add logic to remove props with `@ignore` from getting documented
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.
* Row heights of the header, groupheader, footer, and cell group wrapper | ||
* grouped into a single object. | ||
* | ||
* @ignore |
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.
elementHeights
was getting generated in the API file. This happens since elementHeights
is defaulted prop (defined just below), and react-docgen
adds the entry.
I tried using @ignore
down below instead, but it didn't work. (you can also try playing around here).
@@ -44,7 +44,15 @@ function generatePropDefaultValue(value) { | |||
return 'defaultValue: `' + value.value + '`\n'; | |||
} | |||
|
|||
function shouldIgnoreProp(prop) { |
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.
this could be made inline
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.
lgtm
Updated `roadmap.md`
Description
@ignore
so that they won't get documented.Navigate
#481 - Update codebase
#485 - Update api
#486 - Update roadmap
Motivation and Context
Preparing for beta branch merge to master.
How Has This Been Tested?
Verified that local site's codebase page reflects the changes made here.
Types of changes
Checklist: