Skip to content

Improve documentation clarity for WP-CLI runtime checks and path/URL grammar#1300

Merged
ernilambar merged 2 commits intoWordPress:trunkfrom
mehrazmorshed:patch-1
May 10, 2026
Merged

Improve documentation clarity for WP-CLI runtime checks and path/URL grammar#1300
ernilambar merged 2 commits intoWordPress:trunkfrom
mehrazmorshed:patch-1

Conversation

@mehrazmorshed
Copy link
Copy Markdown
Contributor

What?

This PR improves two documentation sentences of the plugin checker:

  1. Clarifies the wording of the WP-CLI runtime checks workaround.
  2. Fixes a minor grammar issue in the sentence about using an arbitrary path or URL.

Why?

The original phrasing for the runtime checks workaround was somewhat awkward and could be clearer about the required action. The grammar issue (missing "an" and using "could" instead of "can") makes the documentation less professional and slightly harder to read. These changes improve clarity, conciseness, and correctness without altering any technical meaning.

How?

Change 3 (runtime checks workaround):

  • Reworded from: "a workaround is currently necessary using the --require argument of WP-CLI, to manually load the cli.php file within the plugin checker directory before WordPress is loaded."
  • To: "a workaround is currently required: use the --require argument to manually load cli.php from the plugin checker directory before WordPress loads."

Change 4 (path/URL grammar):

  • Changed from: "You could use arbitrary path or URL to check a plugin."
  • To: "You can use an arbitrary path or URL to check a plugin."

Both changes are purely editorial with no functional impact.

Testing Instructions

  1. Read the updated documentation section.
  2. Verify that the WP-CLI workaround explanation is clearer and still technically accurate.
  3. Verify that the path/URL sentence now reads naturally and includes the missing article "an".
  4. Confirm no technical information was lost or altered.

AI Usage Disclosure

  • This PR was created without the help of AI tools
  • This PR includes AI-assisted code or content

If AI tools were used, please describe how they were used:
Used ChatGPT Plus to help rephrase the runtime checks workaround for clarity and to identify the missing article/grammar issue in the path/URL sentence. All changes were reviewed for technical accuracy.

Before After
"a workaround is currently necessary using the --require argument of WP-CLI, to manually load the cli.php file within the plugin checker directory before WordPress is loaded." "a workaround is currently required: use the --require argument to manually load cli.php from the plugin checker directory before WordPress loads."
"You could use arbitrary path or URL to check a plugin." "You can use an arbitrary path or URL to check a plugin."

Clarified the workaround for including runtime checks in WP-CLI by simplifying the wording.
Correct minor grammar issue in the plugin installation section.

The original sentence was missing the article "an" and used "could"
where "can" is more appropriate for instructional documentation.
@github-actions
Copy link
Copy Markdown

github-actions Bot commented May 8, 2026

The following accounts have interacted with this PR and/or linked issues. I will continue to update these lists as activity occurs. You can also manually ask me to refresh this list by adding the props-bot label.

If you're merging code through a pull request on GitHub, copy and paste the following into the bottom of the merge commit message.

Co-authored-by: mehrazmorshed <mehrazmorshed@git.wordpress.org>

To understand the WordPress project's expectations around crediting contributors, please review the Contributor Attribution page in the Core Handbook.

@ernilambar ernilambar merged commit cfd2ae5 into WordPress:trunk May 10, 2026
4 checks passed
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.

3 participants