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

Documentation should be extracted from phpdoc for public interfaces in Optimization Detective #1894

Open
westonruter opened this issue Feb 27, 2025 · 0 comments
Labels
[Plugin] Optimization Detective Issues for the Optimization Detective plugin [Type] Documentation Documentation to be added or enhanced

Comments

@westonruter
Copy link
Member

westonruter commented Feb 27, 2025

The documentation in hooks.md is currently manually copied out of the relevant actions and filters in the Optimization Detective codebase. This could be automated with tooling. Additionally, similar references could be added for public classes which are manually listed out in other documentation.

Any function, class, or method marked as @access private should be excluded from the generated markdown docs.

@westonruter westonruter added [Plugin] Optimization Detective Issues for the Optimization Detective plugin [Type] Documentation Documentation to be added or enhanced labels Feb 27, 2025
@github-project-automation github-project-automation bot moved this to Not Started/Backlog 📆 in WP Performance 2025 Feb 27, 2025
@westonruter westonruter moved this from Not Started/Backlog 📆 to To Do 🔧 in WP Performance 2025 Feb 27, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
[Plugin] Optimization Detective Issues for the Optimization Detective plugin [Type] Documentation Documentation to be added or enhanced
Projects
Status: To Do 🔧
Development

No branches or pull requests

1 participant