Update the README.md file #558
Conversation
swissspidy
added
scope:documentation
Summary of ChangesHello @swissspidy, I'm Gemini Code Assist1! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed! This pull request focuses on enhancing the Highlights
Using Gemini Code AssistThe full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips. Invoking Gemini You can request assistance from Gemini at any point by creating a comment using either
Customization To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a Limitations & Feedback Gemini Code Assist may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments. If you're interested in giving your feedback about your experience with Gemini Code Assist for Github and other Google products, sign up here. You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension. Footnotes
|
![gemini-code-assist[bot]](https://avatars.githubusercontent.com/in/956858?s=60&v=4){kind=small}
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. |
Codecov Report✅ All modified and coverable lines are covered by tests. 📢 Thoughts on this report? Let us know! |
No description provided.