search

wp-cli / doctor-command

Diagnose problems within WordPress by running a series of checks for symptoms
MIT License
146 stars 22 forks source link

documentation clarification: cache-flush detects existence of wp_cache_flush(), not number of occurences #173

Closed joeldcanfield closed 1 year ago

joeldcanfield commented 1 year ago

Documentation states

cache-flush | Detects the number of occurrences of the wp_cache_flush() function.

when it appears that the check is binary: is used, not used.

Documentation could say

cache-flush | Detects any use of the wp_cache_flush() function.

schlessera commented 1 year ago

@joeldcanfield Are you up for a pull request against the docblock?

joeldcanfield commented 1 year ago

Sure.

joeldcanfield commented 1 year ago

Grr. I cannot find the documentation that states this. Perhaps I need to switch from tea to coffee.

joeldcanfield commented 1 year ago

Please ignore my last two comments. I will come back when I'm not distracted. Apologies.

schlessera commented 1 year ago

Ah, no worries, and no pressure!

The docblock that powers the documentation for this particular check can be found here: https://github.com/wp-cli/doctor-command/blob/c5593f15958124c82025a7e9558daff90d34018d/inc/checks/class-cache-flush.php#L10

joeldcanfield commented 1 year ago

thanks for the fix; working on wrapping what's left of my head around the process (one I used to understand well)