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.

Sign up for GitHub

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

Jump to bottom

Update api docs (beta) #485

Merged
merged 3 commits into from
Sep 23, 2019
Merged

Update api docs (beta) #485

merged 3 commits into from
Sep 23, 2019

Conversation

pradeepnschrodinger
Copy link
Collaborator

@pradeepnschrodinger pradeepnschrodinger commented Sep 23, 2019 •
edited
Loading

Description

  • Removed 0.5 api.
  • Removed 0.6 migration guide.
  • Added logic to check props with @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

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to change)

Checklist:

  • My code follows the code style of this project.
  • My change requires a change to the documentation.
  • I have updated the documentation accordingly.
  • I have read the CONTRIBUTING document.

@pradeepnschrodinger
update api
bbe0d13 
* remove 0.6 migration guide
* remove 0.5 api docs
* add logic to remove props with `@ignore` from getting documented
@pradeepnschrodinger
revert port change
d351290
pradeepnschrodinger
pradeepnschrodinger commented Sep 23, 2019
View reviewed changes
Copy link
Collaborator Author

@pradeepnschrodinger pradeepnschrodinger left a comment •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@wcjordan, I think this is the last step in preparing for beta release? Whoops, forgot the PR for roadmap.

After merging #481, #485, and #486, I think we can start merging, cut a release and publish it, update the site, and then close out the stale issues.

src/FixedDataTable.js
* Row heights of the header, groupheader, footer, and cell group wrapper
* grouped into a single object.
*
* @ignore
Copy link
Collaborator Author

@pradeepnschrodinger pradeepnschrodinger Sep 23, 2019 •
edited
Loading

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).

build_helpers/react_documentation/generateMarkdown.js
@@ -44,7 +44,15 @@ function generatePropDefaultValue(value) {
return 'defaultValue: `' + value.value + '`\n';
}

function shouldIgnoreProp(prop) {
Copy link
Collaborator Author

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

@pradeepnschrodinger pradeepnschrodinger mentioned this pull request Sep 23, 2019
Closed
7 tasks
@pradeepnschrodinger pradeepnschrodinger mentioned this pull request Sep 23, 2019
Merged
7 tasks
wcjordan
wcjordan approved these changes Sep 23, 2019
View reviewed changes
Copy link
Member

@wcjordan wcjordan left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

lgtm

@pradeepnschrodinger
Update roadmap (beta) (#486)
fe0087e 
Updated `roadmap.md`
@pradeepnschrodinger pradeepnschrodinger merged commit 13da6df into beta-update-documentation Sep 23, 2019
pradeepnschrodinger added a commit that referenced this pull request Sep 23, 2019
@pradeepnschrodinger
Update docs (#481, #485, #486)
df594c6 
* updated `codebase.md` (#481)
* updated `roadmap.md` (#486)
* removed generated api files for v0.5 (#485)
* removed migration guide for v0.6 (#485)
* added logic for api generation (#485)
 * `@ignore` in the jsdoc will ignore the prop generation through `react-docgen`
@pradeepnschrodinger pradeepnschrodinger deleted the beta-update-documentation-api branch September 24, 2019 09:55
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@wcjordan wcjordan wcjordan approved these changes

@somavara somavara Awaiting requested review from somavara

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

None yet
2 participants
@pradeepnschrodinger @wcjordan