Update the README.md file by swissspidy · Pull Request #558 · wp-cli/entity-command · GitHub
Skip to content

Update the README.md file#558

Merged
swissspidy merged 1 commit into
mainfrom
regenerate-readme
Dec 22, 2025
Merged

Update the README.md file#558
swissspidy merged 1 commit into
mainfrom
regenerate-readme

Conversation

@swissspidy

Copy link
Copy Markdown
Member

No description provided.

@swissspidy swissspidy added this to the 2.9.0 milestone Dec 22, 2025
@swissspidy swissspidy requested a review from a team as a code owner December 22, 2025 09:39
@swissspidy swissspidy added scope:documentation Related to documentation scope:distribution Related to distribution labels Dec 22, 2025
@gemini-code-assist

Copy link
Copy Markdown
Contributor

@swissspidy swissspidy merged commit 6cd25be into main Dec 22, 2025
13 checks passed
@swissspidy swissspidy deleted the regenerate-readme branch December 22, 2025 09:41

@gemini-code-assist gemini-code-assist Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Code Review

This pull request updates the documentation to include examples for the new 'notes' functionality in wp comment and updates several outdated links from the WordPress Codex to the new Developer/Documentation resources. The changes are good and improve the documentation.

However, it appears this PR only modifies the README.md file, which is auto-generated from the PHPDoc comments in the source code. The project's contribution guidelines usually require changes to be made in the source files (e.g., *.php), and then the README.md file should be regenerated. Please ensure the source files are updated and included in this pull request.

I've found one minor formatting issue in the new examples, which I've commented on.

Comment thread README.md

# Create a note (WordPress 6.9+).
$ wp comment create --comment_post_ID=15 --comment_content="This block needs revision" --comment_author="editor" --comment_type="note"
Success: Created comment 933.
 *

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

medium

There appears to be a stray character (a line separator) and an asterisk * at the end of this line. This seems to be a copy-paste or generation artifact and should be removed for correct formatting.

This likely originates from the PHPDoc in src/Comment_Command.php on line 97. Please correct it in the source file and regenerate the README.md.

Suggested change
Success: Created comment 933.
 *
Success: Created comment 933.

@codecov

codecov Bot commented Dec 22, 2025

Copy link
Copy Markdown

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

scope:distribution Related to distribution scope:documentation Related to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant