Skip to content

Clean up array parameter output in documentation#27

Merged
akirk merged 1 commit intomainfrom
fix/clean-array-param-output
Jan 30, 2026
Merged

Clean up array parameter output in documentation#27
akirk merged 1 commit intomainfrom
fix/clean-array-param-output

Conversation

@akirk
Copy link
Copy Markdown
Owner

@akirk akirk commented Jan 30, 2026

Summary

Follow-up to #26 to further clean up the array parameter documentation output:

  • Strip trailing { from array parameter descriptions (e.g., $args {$args)
  • Increase search window from 50 to 100 tokens to capture full array arguments in code snippets
  • Don't output empty parameter descriptions

Example output

## Parameters

- *`array`* `$args`
  - *`string`* `$name` Term name.
  - *`string`* `$slug` Term slug.
  - *`int`* `$parent` Parent term ID.

See multiple_type_tags_hook for a live example.

Test plan

  • Run vendor/bin/phpunit - all 48 tests pass
  • Run vendor/bin/phpcs - no style violations

- Strip trailing { from array parameter descriptions
- Increase search window from 50 to 100 tokens to capture full array arguments
- Don't output empty parameter descriptions
@akirk akirk merged commit 63dd3e9 into main Jan 30, 2026
2 checks passed
@akirk akirk deleted the fix/clean-array-param-output branch January 30, 2026 17:57
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant