Skip to content

Commit 233930c

Browse files
Clarify return void exception.
Co-authored-by: Gary Jones <github@garyjones.io>
1 parent 216c53e commit 233930c

1 file changed

Lines changed: 1 addition & 1 deletion

File tree

  • inline-documentation-standards

inline-documentation-standards/php.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -194,7 +194,7 @@ Functions and class methods should be formatted as follows:
194194
- **`@link`**: URL that provides more information. This should never be used to reference another function, hook, class, or method, see `@see`.
195195
- **`@global`**: List PHP globals that are used within the function or method, with an optional description of the global. If multiple globals are listed, they should be aligned by type, variable, and description, with each other as a group.
196196
- **`@param`**: Note if the parameter is _Optional_ before the description, and include a period at the end. The description should mention accepted values as well as the default. For example: _Optional. This value does something. Accepts 'post', 'term', or empty. Default empty._
197-
- **`@return`**: Should contain all possible return types, and a description for each. Use a period at the end. Note: `@return void` should not be used outside of the default bundled themes and the Core included PHP compatibility shims.
197+
- **`@return`**: Should contain all possible return types and a description for each. Use a period at the end. Note: `@return void` should not be used outside the default bundled themes and the PHP compatibility shims included in WordPress Core.
198198

199199
```php
200200
/**

0 commit comments

Comments
 (0)