update code sample in README#102
Merged
remarkablemark merged 1 commit intoremarkablemark:masterfrom Apr 25, 2019
Merged
Conversation
Owner
remarkablemark
left a comment
There was a problem hiding this comment.
Looks good @scott-silver! Do you mind amending your commit message so it follows the conventional commits format?
$ git commit --amend -m "docs(readme): update code sample"
$ git push origin silver/update-readme -fIt helps with determining the semver release, which is why CI lints the commit message.
| </span> | ||
| </p> | ||
| `, | ||
| { |
Owner
There was a problem hiding this comment.
Technically, a variable doesn't need to be created here. However, I am okay with this refactor to improve readability.
README.md
Outdated
| @@ -125,6 +125,26 @@ import { renderToStaticMarkup } from 'react-dom/server'; | |||
| import parse from 'html-react-parser'; | |||
| import domToReact from 'html-react-parser/lib/dom-to-react'; | |||
Owner
There was a problem hiding this comment.
Since we're updating this code block, do you mind remove this line and updating the line above?
import parse, { domToReact } from 'html-react-parser';fb0d9ad to
b34afd8
Compare
b34afd8 to
f3f524e
Compare
remarkablemark
approved these changes
Apr 25, 2019
Owner
|
The build failure was due to an error in the |
Owner
|
@scott-silver This will go out in the next release when a feature/bugfix has been merged |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
What is the motivation for this pull request?
Better documentation
What is the current behavior?
Currently, the code sample in the README makes reference to a variable called
parserOptions, even though that variable does not exist within the sample.It seems that this variable is actually a reference to the object that contains the
replacemethod, and that object should get passed in as the second argument to the calls todomToReact.What is the new behavior?
The new code sample creates a constant called
parserOptions, which can then be passed as the second argument todomToReact.Thanks!