-
Notifications
You must be signed in to change notification settings - Fork 1.4k
README update for "Install Python dependencies" #416
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
base: main
Are you sure you want to change the base?
README update for "Install Python dependencies" #416
Conversation
Summary of ChangesHello @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
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
|
There was a problem hiding this 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 |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
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.
| 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 |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
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.
| 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 |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
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.
| 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 |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
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.
| 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 |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
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.
| 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 |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
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.
| 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 |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
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.
| 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 |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
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.
| 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 |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
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.
| 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 |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
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.
| python -m pip install poetry==2.0.1 && poetry install -C api | |
| python3 -m pip install poetry==2.0.1 && poetry install -C api |
I found difference between README documents so I created PR for following modifications.