docs: update translated READMEs to reference Poetry instead of requirements.txt#523
Open
mvanhorn wants to merge 1 commit into
Open
docs: update translated READMEs to reference Poetry instead of requirements.txt#523mvanhorn wants to merge 1 commit into
mvanhorn wants to merge 1 commit into
Conversation
…ements.txt The repo migrated from requirements.txt to Poetry in PR AsyncFuncAI#380 (2025-10-23) and PR AsyncFuncAI#433 updated only README.md. The 9 translated READMEs still showed the removed requirements.txt in their project structure tree. Closes AsyncFuncAI#502
Contributor
There was a problem hiding this comment.
Code Review
This pull request updates the directory structure documentation across multiple localized README files to reflect the switch from requirements.txt to Poetry-based dependency management using pyproject.toml and poetry.lock. Feedback was provided regarding the Chinese README to maintain consistent spacing between English and Chinese characters in the file's comments.
| │ ├── data_pipeline.py # 数据处理工具 | ||
| │ └── requirements.txt # Python依赖 | ||
| │ ├── pyproject.toml # Python依赖 (Poetry) | ||
| │ └── poetry.lock # 已锁定的 Python 依赖版本 |
Contributor
There was a problem hiding this comment.
The spacing between English and Chinese characters is inconsistent with line 161 and the rest of the file (e.g., line 158). To maintain consistency with the existing style, the spaces around "Python" should be removed.
Suggested change
| │ └── poetry.lock # 已锁定的 Python 依赖版本 | |
| │ └── poetry.lock # 已锁定的Python依赖版本 |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
The 9 translated READMEs still show
requirements.txtin their project-structure tree. The repo migrated to Poetry in #380 and PR #433 updated only the English README to match (pyproject.toml+poetry.lock). This patch brings the translated structure trees in line.Why this matters
#502 flagged that the
api/directory has norequirements.txt. The English README is correct; the 9 translated READMEs still list it, which sends readers looking for a file that does not exist.Changes
For each translated README, the single line:
is replaced with the two-line layout that already exists in the English README:
Per-language comments translate "Python dependencies (Poetry)" and "Locked Python dependency versions" into the same register the file already uses.
README.vi.mdkeeps English text for this entry, matching the prior line's existing style.Testing
Docs-only change. No test runner invoked. Spot-checked the tree alignment in each file.
Notes
Touches the same 9 translated READMEs as the open #508 (docker-compose v1 → v2), but on different lines (project-structure tree vs docker-compose command). Can merge in either order; will rebase if #508 lands first.
Closes #502
AI was used for assistance.