Skip to content

Conversation

@Taurin190
Copy link

I found difference between README documents so I created PR for following modifications.

  • update README.md poetry version from 1.8.2 to 2.0.1
  • add directory option for multi language README.*.md

@gemini-code-assist
Copy link
Contributor

Summary of Changes

Hello @Taurin190, 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 improving the clarity and correctness of the Python dependency installation instructions across all README documentation files. It updates the specified Poetry version in the main English README and ensures that all localized READMEs correctly point Poetry to the 'api' directory for dependency installation, streamlining the project setup for users regardless of their preferred language.

Highlights

  • Poetry Version Update: The recommended Poetry version in the main README.md has been updated from 1.8.2 to 2.0.1, ensuring users install with a more recent and stable version.
  • Dependency Installation Directory: All localized README.*.md files now include the -C api option in the poetry install command, directing Poetry to install dependencies specifically within the 'api' directory. This standardizes the setup process across all language versions of the documentation.
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 by creating a comment using either /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands on the current page.

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 pull request 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

  1. 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.

Copy link
Contributor

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

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 README.md files across multiple languages to ensure consistency in the Python dependency installation instructions. The poetry version is updated to 2.0.1 in the main README.md, and the poetry install command is corrected to target the api directory in all translated versions. These are excellent changes for documentation accuracy. I've added suggestions to use python3 instead of python in the installation commands to prevent potential issues on systems with multiple Python versions.

```bash
# Instalar dependencias de Python
python -m pip install poetry==2.0.1 && poetry install
python -m pip install poetry==2.0.1 && poetry install -C api
Copy link
Contributor

Choose a reason for hiding this comment

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

medium

To improve clarity and avoid potential issues on systems where python might refer to Python 2, it's a good practice to explicitly use python3 in installation commands. This ensures the correct Python version is used, aligning with modern Python development practices.

Suggested change
python -m pip install poetry==2.0.1 && poetry install -C api
python3 -m pip install poetry==2.0.1 && poetry install -C api

```bash
# Installer dépendances Python
python -m pip install poetry==2.0.1 && poetry install
python -m pip install poetry==2.0.1 && poetry install -C api
Copy link
Contributor

Choose a reason for hiding this comment

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

medium

To improve clarity and avoid potential issues on systems where python might refer to Python 2, it's a good practice to explicitly use python3 in installation commands. This ensures the correct Python version is used, aligning with modern Python development practices.

Suggested change
python -m pip install poetry==2.0.1 && poetry install -C api
python3 -m pip install poetry==2.0.1 && poetry install -C api

```bash
# Pythonの依存関係をインストール
python -m pip install poetry==2.0.1 && poetry install
python -m pip install poetry==2.0.1 && poetry install -C api
Copy link
Contributor

Choose a reason for hiding this comment

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

medium

To improve clarity and avoid potential issues on systems where python might refer to Python 2, it's a good practice to explicitly use python3 in installation commands. This ensures the correct Python version is used, aligning with modern Python development practices.

Suggested change
python -m pip install poetry==2.0.1 && poetry install -C api
python3 -m pip install poetry==2.0.1 && poetry install -C api

```bash
# Python 의존성 설치
python -m pip install poetry==2.0.1 && poetry install
python -m pip install poetry==2.0.1 && poetry install -C api
Copy link
Contributor

Choose a reason for hiding this comment

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

medium

To improve clarity and avoid potential issues on systems where python might refer to Python 2, it's a good practice to explicitly use python3 in installation commands. This ensures the correct Python version is used, aligning with modern Python development practices.

Suggested change
python -m pip install poetry==2.0.1 && poetry install -C api
python3 -m pip install poetry==2.0.1 && poetry install -C api

```bash
# Install Python dependencies
python -m pip install poetry==1.8.2 && poetry install -C api
python -m pip install poetry==2.0.1 && poetry install -C api
Copy link
Contributor

Choose a reason for hiding this comment

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

medium

To improve clarity and avoid potential issues on systems where python might refer to Python 2, it's a good practice to explicitly use python3 in installation commands. This ensures the correct Python version is used, aligning with modern Python development practices.

Suggested change
python -m pip install poetry==2.0.1 && poetry install -C api
python3 -m pip install poetry==2.0.1 && poetry install -C api

```bash
# Instale as dependências Python
python -m pip install poetry==2.0.1 && poetry install
python -m pip install poetry==2.0.1 && poetry install -C api
Copy link
Contributor

Choose a reason for hiding this comment

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

medium

To improve clarity and avoid potential issues on systems where python might refer to Python 2, it's a good practice to explicitly use python3 in installation commands. This ensures the correct Python version is used, aligning with modern Python development practices.

Suggested change
python -m pip install poetry==2.0.1 && poetry install -C api
python3 -m pip install poetry==2.0.1 && poetry install -C api

```bash
# Установка зависимостей
python -m pip install poetry==2.0.1 && poetry install
python -m pip install poetry==2.0.1 && poetry install -C api
Copy link
Contributor

Choose a reason for hiding this comment

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

medium

To improve clarity and avoid potential issues on systems where python might refer to Python 2, it's a good practice to explicitly use python3 in installation commands. This ensures the correct Python version is used, aligning with modern Python development practices.

Suggested change
python -m pip install poetry==2.0.1 && poetry install -C api
python3 -m pip install poetry==2.0.1 && poetry install -C api

```bash
# Cài đặt Python dependencies
python -m pip install poetry==2.0.1 && poetry install
python -m pip install poetry==2.0.1 && poetry install -C api
Copy link
Contributor

Choose a reason for hiding this comment

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

medium

To improve clarity and avoid potential issues on systems where python might refer to Python 2, it's a good practice to explicitly use python3 in installation commands. This ensures the correct Python version is used, aligning with modern Python development practices.

Suggested change
python -m pip install poetry==2.0.1 && poetry install -C api
python3 -m pip install poetry==2.0.1 && poetry install -C api

```bash
# 安裝 Python 相依性
python -m pip install poetry==2.0.1 && poetry install
python -m pip install poetry==2.0.1 && poetry install -C api
Copy link
Contributor

Choose a reason for hiding this comment

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

medium

To improve clarity and avoid potential issues on systems where python might refer to Python 2, it's a good practice to explicitly use python3 in installation commands. This ensures the correct Python version is used, aligning with modern Python development practices.

Suggested change
python -m pip install poetry==2.0.1 && poetry install -C api
python3 -m pip install poetry==2.0.1 && poetry install -C api

```bash
# 安装Python依赖
python -m pip install poetry==2.0.1 && poetry install
python -m pip install poetry==2.0.1 && poetry install -C api
Copy link
Contributor

Choose a reason for hiding this comment

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

medium

To improve clarity and avoid potential issues on systems where python might refer to Python 2, it's a good practice to explicitly use python3 in installation commands. This ensures the correct Python version is used, aligning with modern Python development practices.

Suggested change
python -m pip install poetry==2.0.1 && poetry install -C api
python3 -m pip install poetry==2.0.1 && poetry install -C api

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

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant