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

Fix slate-react plugin documentation #2910

Merged
merged 1 commit into from Jul 5, 2019

Conversation

Projects
None yet
2 participants
@Calyhre
Copy link
Contributor

commented Jul 4, 2019

Is this adding or improving a feature or fixing a bug?

Improving documentation

What's the new behavior?

  • renderMark is documented
  • renderDecoration & renderAnnotation reflect actual code

How does this change work?

The slate-react documentation has recently been updated to reflect lastest breaking changes, but renderMark has been wrongfully removed. This also fixe some incoherent props for renderDecoration & renderAnnotation.

Have you checked that...?

  • The new code matches the existing patterns and styles.
  • The tests pass with yarn test.
  • The linter passes with yarn lint. (Fix errors with yarn prettier.)
  • The relevant examples still work. (Run examples with yarn watch.)

Does this fix any issues or need any specific reviewers?

Fixes: #
Reviewers: @ianstormtaylor

Fix slate-react plugin documentation
* Re-add removed renderMark
* Fix renderAnnotation & renderDecoration props
@ianstormtaylor

This comment has been minimized.

Copy link
Owner

commented Jul 5, 2019

Thanks @Calyhre!

@ianstormtaylor ianstormtaylor merged commit 7377266 into ianstormtaylor:master Jul 5, 2019

2 checks passed

continuous-integration/travis-ci/pr The Travis CI build passed
Details
deploy/netlify Deploy preview ready!
Details

@ianstormtaylor ianstormtaylor added the docs label Jul 5, 2019

justinweiss added a commit to aha-app/slate that referenced this pull request Jul 15, 2019

Fix slate-react plugin documentation (ianstormtaylor#2910)
* Re-add removed renderMark
* Fix renderAnnotation & renderDecoration props
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
You can’t perform that action at this time.