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 type docs for Notices #17206

Merged
merged 3 commits into from Aug 30, 2019

Conversation

@simono
Copy link
Contributor

commented Aug 26, 2019

Description

Fix documentation errors as explained in #17203.

Types of changes

  • fixes docs

Checklist:

  • My code is tested.
  • My code follows the WordPress code style.
  • My code follows the accessibility standards.
  • My code has proper inline documentation.
  • I've included developer documentation if appropriate.
@simono simono changed the title Fix/17203 notices type docs Fix #17203 Notices type docs Aug 26, 2019
@simono simono changed the title Fix #17203 Notices type docs Fix type docs for Notices Aug 26, 2019
@gziolo gziolo requested review from dsifford and ocean90 Aug 27, 2019
Copy link
Contributor

left a comment

See comments.

packages/notices/src/store/actions.js Outdated Show resolved Hide resolved
@gziolo

This comment has been minimized.

Copy link
Member

commented Aug 30, 2019

Travis job fails. It looks like you need to run “npm run docs:build” to refresh docs.

@simono

This comment has been minimized.

Copy link
Contributor Author

commented Aug 30, 2019

Thanks for the heads-up @gziolo
The build passed now.

Just out of curiosity: Why are those generated docs in version control?

@gziolo

This comment has been minimized.

Copy link
Member

commented Aug 30, 2019

Just out of curiosity: Why are those generated docs in version control?

We use GitHub source to power developer docs: https://developer.wordpress.org/block-editor/data/data-core-notices/ but at the same time, you can browse them on GitHub. Ideally, bot should run npm run docs:build and add a commit to your PR when necessary. I hope we will get there one day :)

@gziolo gziolo added this to the Gutenberg 6.5 milestone Aug 30, 2019
@gziolo gziolo merged commit 1abf936 into WordPress:master Aug 30, 2019
2 checks passed
2 checks passed
pull-request-automation
Details
Travis CI - Pull Request Build Passed
Details
@gziolo

This comment has been minimized.

Copy link
Member

commented Aug 30, 2019

Congrats on your first code contribution to Gutenberg 🎉

@simono simono deleted the simono:fix/17203-notices-type-docs branch Aug 30, 2019
@simono

This comment has been minimized.

Copy link
Contributor Author

commented Aug 30, 2019

Thanks for the merge and all the help @gziolo

dd32 pushed a commit to dd32/gutenberg that referenced this pull request Sep 27, 2019
* Notices: Fix docs for optional params.

Fixes WordPress#17203

* Notices: Document missing properties.

Fixes WordPress#17203

* Notices: Rename `callback` to `onClick` for `WPNoticeAction`.

Fixes WordPress#17203
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.