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

Correct the format used for duplicate hook docs #32563

Merged
merged 1 commit into from
Jun 11, 2021

Conversation

johnbillion
Copy link
Member

@johnbillion johnbillion commented Jun 9, 2021

Description

This fixes the format used for a duplicate hook doc.

This should use a block-level comment instead of an inline comment. The inline comment format causes WP Parser to see the hook as undocumented.

How has this been tested?

I confirmed that WP Parser Lib no longer treats this as an undocumented hook.

Types of changes

Bug fix

Checklist:

  • My code is tested.
  • My code follows the WordPress code style.
  • My code follows the accessibility standards.
  • I've tested my changes with keyboard and screen readers.
  • My code has proper inline documentation.
  • I've included developer documentation if appropriate.
  • I've updated all React Native files affected by any refactorings/renamings in this PR (please manually search all *.native.js files for terms that need renaming or removal).

lib/edit-site-page.php Outdated Show resolved Hide resolved
Copy link
Member

@gziolo gziolo left a comment

Choose a reason for hiding this comment

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

This PR needs a rebase. It would be great to land the change for Latest Comments block 👍🏻

The other comment was probably fixed and moved to another place.

@johnbillion johnbillion force-pushed the duplicate-hook-docs branch from c008cd2 to 2d9e453 Compare June 11, 2021 10:08
@gziolo gziolo added [Type] Code Quality Issues or PRs that relate to code quality [Block] Latest Comments Affects the Latest Comments Block labels Jun 11, 2021
Copy link
Member

@gziolo gziolo left a comment

Choose a reason for hiding this comment

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

Thank you, let's merge when CI turns green.

@gziolo gziolo merged commit 289b13c into WordPress:trunk Jun 11, 2021
@github-actions github-actions bot added this to the Gutenberg 10.9 milestone Jun 11, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
[Block] Latest Comments Affects the Latest Comments Block [Type] Code Quality Issues or PRs that relate to code quality
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants