Skip to content

Update README.md#15249

Closed
manooweb wants to merge 1 commit intoWordPress:masterfrom
manooweb:patch-1
Closed

Update README.md#15249
manooweb wants to merge 1 commit intoWordPress:masterfrom
manooweb:patch-1

Conversation

@manooweb
Copy link
Copy Markdown
Contributor

fix typo in withDispatch paragraph

@Soean Soean added the [Type] Developer Documentation Documentation for developers label Apr 29, 2019
Copy link
Copy Markdown
Member

@Soean Soean left a comment

Choose a reason for hiding this comment

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

Thanks, good catch!

@chrisvanpatten
Copy link
Copy Markdown
Contributor

Is this a section of the README which is automatically generated? It's not clear to me looking at the diff…

@manooweb
Copy link
Copy Markdown
Contributor Author

Directly in the README here https://github.com/WordPress/gutenberg/tree/master/packages/data#withDispatch

The first change : to unnecessary re-renders of you component caused replaced by your instead

and the second one a double "with" deleted

@chrisvanpatten
Copy link
Copy Markdown
Contributor

@manooweb It looks like your changes start on line 467, but the autogenerated docs start on line 249.

I think you'll need to edit the inline documentation directly here: https://github.com/WordPress/gutenberg/blob/master/packages/data/src/components/with-dispatch/index.js#L51

Then when the docs are compiled, it will update the README automatically.

@Soean
Copy link
Copy Markdown
Member

Soean commented Apr 29, 2019

Thanks @chrisvanpatten. Of course, you have to edit it in the source code and then run npm run docs:build

@manooweb
Copy link
Copy Markdown
Contributor Author

manooweb commented Apr 29, 2019

Ok. I see :-) I didn't know that this doc was built from code.
I'm doing it in code a coming back later :-)

@manooweb manooweb closed this Apr 29, 2019
@manooweb manooweb deleted the patch-1 branch April 29, 2019 14:52
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

[Type] Developer Documentation Documentation for developers

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants