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

Improve Optimization Detective documentation #1782

Draft
wants to merge 3 commits into
base: trunk
Choose a base branch
from

Conversation

westonruter
Copy link
Member

@westonruter westonruter commented Jan 9, 2025

This is a follow-up to #1763.

  • Remove @access private from interfaces which are intended to be exposed.
  • How to write an extension
  • Class reference
  • Function reference
  • JSON Schema
  • Remove access private from anything exposed by filters or hooks
  • Extract hooks docs from PHPDoc? This could should include improved formatting of the accepted arguments to each action/filter.

@westonruter westonruter added [Plugin] Optimization Detective Issues for the Optimization Detective plugin [Type] Documentation Documentation to be added or enhanced labels Jan 9, 2025
Copy link

codecov bot commented Jan 9, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 57.38%. Comparing base (dde008b) to head (32a95ab).
Report is 14 commits behind head on trunk.

Additional details and impacted files
@@           Coverage Diff           @@
##            trunk    #1782   +/-   ##
=======================================
  Coverage   57.38%   57.38%           
=======================================
  Files          84       84           
  Lines        6504     6504           
=======================================
  Hits         3732     3732           
  Misses       2772     2772           
Flag Coverage Δ
multisite 57.38% <ø> (ø)
single 34.42% <ø> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

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
None yet
Development

Successfully merging this pull request may close these issues.

1 participant