Fix formatting #253
Fix formatting #253
Conversation
![gemini-code-assist[bot]](https://avatars.githubusercontent.com/in/956858?s=60&v=4){kind=small}
There was a problem hiding this comment.
Summary of Changes
Hello @rashidi, 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 primarily focuses on improving the readability and accuracy of the documentation. It includes updates to AsciiDoc formatting for better link rendering and corrects specific example data within the data-rest-composite-id tutorial documentation.
Highlights
- AsciiDoc Formatting Updates: I've updated the AsciiDoc syntax for linking to source files in
README.adocanddata-rest-composite-id.adoc. The oldClassName[path]format has been replaced withlink:{path}[ClassName]to ensure proper rendering of these links in the generated documentation. - Documentation Cleanup: The
:toc:attribute has been removed fromdocs/modules/ROOT/pages/data-rest-composite-id.adoc. This change affects the automatic generation of a table of contents for this specific document. - Example Data Correction: I've corrected the example ISBN and author ID values within the
docs/modules/ROOT/pages/data-rest-composite-id.adocfile. This includes updating the ISBN in aPOSTrequest example and adjusting the author ID in SQLINSERTstatements to use200instead of100.
Using Gemini Code Assist
The 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 in your pull request via creating an issue comment (i.e. comment on the pull request page) using either /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands.
| Feature | Command | Description |
|---|---|---|
| Code Review | /gemini review |
Performs a code review for the current pull request in its current state. |
| Pull Request Summary | /gemini summary |
Provides a summary of the current pull request in its current state. |
| Comment | @gemini-code-assist | Responds in comments when explicitly tagged, both in issue comments and review comments. |
| Help | /gemini help |
Displays a list of available commands. |
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 .gemini/ folder in the base of the repository. Detailed instructions can be found here.
Limitations & Feedback
Gemini Code Assist is currently in preview and 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 to provide feedback.
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
-
Review the Privacy Notices, Generative AI Prohibited Use Policy, Terms of Service, and learn how to configure Gemini Code Assist in GitHub here. Gemini can make mistakes, so double check it and use code with caution. ↩
There was a problem hiding this comment.
Code Review
This PR fixes formatting and updates documentation snippets in .adoc files to align them with the test code. The changes improve the accuracy of the documentation. I've added a couple of suggestions to further improve maintainability and clarity: one regarding duplicated documentation files, and another about an inconsistency in the example data that could be confusing for readers.
| "isbn": "9781402745777", | ||
| "title": "The Jungle Book", | ||
| "author": "http://localhost/authors/100" | ||
| } | ||
| """) | ||
| .assertThat().headers() | ||
| .extracting(LOCATION).asString().isEqualTo("http://localhost/books/9781509827829"); | ||
| .extracting(LOCATION).asString().isEqualTo("http://localhost/books/9781402745777"); |
There was a problem hiding this comment.
While this change correctly aligns the create() test snippet with the CreateBookTests.java file, it introduces an inconsistency within this documentation page. The create() test now uses ISBN 9781402745777 for "The Jungle Book", while the get() test further down uses 9781509827829 for what appears to be the same book.
This can be confusing for a reader following the tutorial. For a more coherent tutorial, it would be ideal if the underlying test files used consistent data. I'm pointing this out as a potential source of confusion that might be worth addressing in the test code in a future change.
No description provided.