[IMP] installation_deb and remove csv lexex on dev guide #68
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 @emjay0921, 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 enhances the project's documentation by fixing a broken internal link in the installation instructions and standardizing the syntax highlighting for code blocks across various developer guide files, improving overall accuracy and readability.
Highlights
- Documentation Link Correction: Corrected an incorrect relative path for the "setting up pilot programs" documentation link within the Debian installation guide.
- Code Block Syntax Update: Updated numerous code blocks in the developer guide from
csvto generic syntax highlighting to ensure proper rendering and broader compatibility for CSV examples.
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 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
-
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 pull request primarily addresses documentation improvements. It fixes a broken link in the installation guide and removes the csv lexer from code blocks in the developer guide, likely to resolve build issues. I've provided suggestions to use the text specifier for these code blocks for better clarity and maintainability. The link fix appears correct. Also, please note the minor typo ('lexex' instead of 'lexer') in the pull request title.
| If you introduce new models, add access rights. For simple field additions, this is not required. Example: | ||
|
|
||
| ```csv | ||
| ``` |
There was a problem hiding this comment.
For better readability and to be more explicit about the content type, it's recommended to use a language specifier for code blocks. Since this block contains CSV data, which is plain text, using text is a good practice instead of a bare fence. This avoids ambiguity and improves maintainability, even if syntax highlighting is not desired or available.
| ``` | |
| ```text |
| If you introduce new models, add access rights. For simple field additions, this is not required. Example: | ||
|
|
||
| ```csv | ||
| ``` |
There was a problem hiding this comment.
For better readability and to be more explicit about the content type, it's recommended to use a language specifier for code blocks. Since this block contains CSV data, which is plain text, using text is a good practice instead of a bare fence. This avoids ambiguity and improves maintainability, even if syntax highlighting is not desired or available.
| ``` | |
| ```text |
| to the base user group. | ||
|
|
||
| ```csv | ||
| ``` |
There was a problem hiding this comment.
For better readability and to be more explicit about the content type, it's recommended to use a language specifier for code blocks. Since this block contains CSV data, which is plain text, using text is a good practice instead of a bare fence. This avoids ambiguity and improves maintainability, even if syntax highlighting is not desired or available.
| ``` | |
| ```text |
| Grant users access to your new model in `security/ir.model.access.csv`. | ||
|
|
||
| ```csv | ||
| ``` |
There was a problem hiding this comment.
For better readability and to be more explicit about the content type, it's recommended to use a language specifier for code blocks. Since this block contains CSV data, which is plain text, using text is a good practice instead of a bare fence. This avoids ambiguity and improves maintainability, even if syntax highlighting is not desired or available.
| ``` | |
| ```text |
| Grant users access to your new models in `security/ir.model.access.csv`. | ||
|
|
||
| ```csv | ||
| ``` |
There was a problem hiding this comment.
For better readability and to be more explicit about the content type, it's recommended to use a language specifier for code blocks. Since this block contains CSV data, which is plain text, using text is a good practice instead of a bare fence. This avoids ambiguity and improves maintainability, even if syntax highlighting is not desired or available.
| ``` | |
| ```text |
| If you introduce new models, add access rights. For a simple field addition to `res.partner`, this is not required. Example: | ||
|
|
||
| ```csv | ||
| ``` |
There was a problem hiding this comment.
For better readability and to be more explicit about the content type, it's recommended to use a language specifier for code blocks. Since this block contains CSV data, which is plain text, using text is a good practice instead of a bare fence. This avoids ambiguity and improves maintainability, even if syntax highlighting is not desired or available.
| ``` | |
| ```text |
| If you introduce new models, add access rights. For simple field additions, this is not required. Example: | ||
|
|
||
| ```csv | ||
| ``` |
There was a problem hiding this comment.
For better readability and to be more explicit about the content type, it's recommended to use a language specifier for code blocks. Since this block contains CSV data, which is plain text, using text is a good practice instead of a bare fence. This avoids ambiguity and improves maintainability, even if syntax highlighting is not desired or available.
| ``` | |
| ```text |
| Grant users access to your new model in `security/ir.model.access.csv`. At a minimum, you need to provide access to the relevant user groups, such as program managers and administrators. | ||
|
|
||
| ```csv | ||
| ``` |
There was a problem hiding this comment.
For better readability and to be more explicit about the content type, it's recommended to use a language specifier for code blocks. Since this block contains CSV data, which is plain text, using text is a good practice instead of a bare fence. This avoids ambiguity and improves maintainability, even if syntax highlighting is not desired or available.
| ``` | |
| ```text |
| Create `security/ir.model.access.csv`: | ||
|
|
||
| ```csv | ||
| ``` |
There was a problem hiding this comment.
For better readability and to be more explicit about the content type, it's recommended to use a language specifier for code blocks. Since this block contains CSV data, which is plain text, using text is a good practice instead of a bare fence. This avoids ambiguity and improves maintainability, even if syntax highlighting is not desired or available.
| ``` | |
| ```text |
|
No description provided.