Merged
Conversation
Contributor
obenland
commented
Jul 30, 2025
- Integrate PHPDoc-style function documentation directly into prefixed example style.
- Align parameter variables in @param annotations for improved readability.
- Ensure descriptions end with trailing periods for consistency.
- Add parameter descriptions from hook metadata when available.
- Update test fixtures to reflect the new integrated documentation style.
- Integrate PHPDoc-style function documentation directly into prefixed example style - Align parameter variables in @param annotations for improved readability - Ensure descriptions end with trailing periods for consistency - Add parameter descriptions from hook metadata when available - Update test fixtures to reflect the new integrated documentation style - Create FunctionDocsTest class to validate function documentation generation - Remove redundant newlines in generated documentation blocks
obenland
commented
Jul 30, 2025
| * | ||
| * @param string $setting | ||
| * @param int $user_id | ||
| * @param array $options |
Contributor
Author
There was a problem hiding this comment.
It's still missing parameter docs. Will do that in a follow-up PR.
akirk
approved these changes
Aug 1, 2025
Owner
akirk
left a comment
There was a problem hiding this comment.
Nice! I might make this configurable so that you can switch it off to have shorter example code.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.