-
Notifications
You must be signed in to change notification settings - Fork 4.1k
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
Document the naming convention for block-library
PHP functions
#53777
Document the naming convention for block-library
PHP functions
#53777
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thank you for the follow-up. I had only a minor note. Otherwise, this looks great.
packages/block-library/README.md
Outdated
@@ -119,4 +119,23 @@ To find out more about contributing to this package or Gutenberg as a whole, ple | |||
} | |||
``` | |||
|
|||
### Naming convention for PHP functions | |||
|
|||
All PHP function names within the subdirectories of the `packages/block-library/src/` directory should start with one of the following prefixes: |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Should it be clarified that it applies to function definitions? Example:
All PHP function names within the subdirectories of the `packages/block-library/src/` directory should start with one of the following prefixes: | |
All declared PHP function names within the subdirectories of the `packages/block-library/src/` directory should start with one of the following prefixes: |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Good catch. Fixed in 0586c63.
Thank you for the code review, @gziolo. I appreciate it. |
What?
This PR is intended to document the following naming convention: #52769 (comment).
Fixes #53732.
Why?
Documenting every naming convention is essential.
How?
ValidBlockLibraryFunctionNameSniff
.Testing Instructions
Please review the suggested changes for accuracy, grammar, and style errors.
Testing Instructions for Keyboard
Screenshots or screencast