Update the README.md file#558
Conversation
There was a problem hiding this comment.
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.
|
|
||
| # 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. * |
There was a problem hiding this comment.
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.
| Success: Created comment 933. * | |
| Success: Created comment 933. |

No description provided.