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

Update/16128 add attribute types documentation #16220

Merged
merged 5 commits into from
Jun 20, 2019
Merged

Update/16128 add attribute types documentation #16220

merged 5 commits into from
Jun 20, 2019

Conversation

AdamDTak2112
Copy link
Contributor

Description

Fixes #16128 . Added accepted attribute types for the Blocks API, including a link to the Wordpress REST API documentation for clarification.

How has this been tested?

Ran changes in docs through Visual Studio Code's markdown preview testing.

Changes should not affect any other code, as it was purely an addition to documentation. No existing documentation was altered.

Screenshots

Types of changes

Only a change in documentation, as clarification was requested through #16128 .

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.

Added valid inputs to the type field in attributions on block-attributes.md
Copy link
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 for contributing.

Copy link
Member

@mkaz mkaz left a comment

Choose a reason for hiding this comment

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

Looks good, I added one suggestion for the link.

Also, not a big deal, but you have a definition for integer, but not number. I would add for both or neither, just the types seems sufficient to me.

Copy link
Contributor

@chrisvanpatten chrisvanpatten left a comment

Choose a reason for hiding this comment

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

Just adding a block on the PR until this change (a combo of mine + @mkaz's changes) is merged in, then I'd love to see this landed. Thanks!

See [WordPress's REST API documentation](https://developer.wordpress.org/rest-api/extending-the-rest-api/schema/) for additional details.

…s.md

Co-Authored-By: Chris Van Patten <hello@chrisvanpatten.com>
AdamDTak2112 and others added 2 commits June 19, 2019 14:30
I was advised by the core contributors to either add a definition for number, or delete the definition for integer. After noting that a definition of number (either an integer or floating point number) could create more confusion, I opted for the latter choice.
…s.md

Co-Authored-By: Chris Van Patten <hello@chrisvanpatten.com>
@AdamDTak2112
Copy link
Contributor Author

AdamDTak2112 commented Jun 19, 2019

I've taken the suggestions from @mkaz and @chrisvanpatten. I committed the changes, and please let me know if there is anything else that needs to be changed.

Thank you so much for letting me contribute to this! I promise I'll capitalize the P from now on :)

@Soean Soean merged commit 268b95d into WordPress:master Jun 20, 2019
@github-actions github-actions bot added this to the Gutenberg 6.0 milestone Jun 20, 2019
@Soean
Copy link
Member

Soean commented Jun 20, 2019

Thanks for the changes and welcome as a new Gutenberg contributor!

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.

Add attribute types to docs
4 participants