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

Block Editor: LinkControl: Align documentation with current behavior #19736

Merged
merged 4 commits into from
Jan 20, 2020

Conversation

aduth
Copy link
Member

@aduth aduth commented Jan 17, 2020

This pull request seeks to address a few consistency issues with the LinkControl documentation:

  • There is no className prop
  • value is not required
  • onChange will always receive an item, never null
  • The onChange example referenced the wrong (old) prop onLinkChange, and the example used an impossible scenario that the changed item could be falsey.
  • The tests reference behavior of "required props", but there are no required props

Separately, I would like to improve documentation and types concerning what a value actually is. These are intended as an incremental step in that direction.

Testing Instructions:

The only changes impact documentation and tests. There is no expected impact on the behavior of the application runtime.

Ensure unit tests pass:

npm run test-unit

@aduth aduth added [Type] Developer Documentation Documentation for developers [Type] Code Quality Issues or PRs that relate to code quality [Package] Block editor /packages/block-editor labels Jan 17, 2020
@aduth aduth requested review from youknowriad and getdave January 17, 2020 21:12
@aduth aduth mentioned this pull request Jan 17, 2020
40 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
[Package] Block editor /packages/block-editor [Type] Code Quality Issues or PRs that relate to code quality [Type] Developer Documentation Documentation for developers
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants