[Fix&Enhance&Format] On README.md about poetry install #1146

coolermzb3 · 2024-05-11T21:14:04Z

I have added the correct label(s) to this Pull Request or linked the relevant issue(s)
I have provided a description of the changes in this Pull Request
I have added documentation for my changes and have listed relevant changes in CHANGELOG.md
If applicable, I have added tests to cover my changes.
I have reformatted the code using poe format
I have checked style and types with poe lint and poe type-check
(Optional) I ran tests locally with poe test
(or a subset of them with poe test-reduced) ,and they pass
(Optional) I have tested that documentation builds correctly with poe doc-build

[fix] First commit is crucial, otherwise poetry fails with No arguments expected for "install" command, got "envpool". It's clear in poetry-doc that quote marks are needed.
[enh] Second commit is optional, I encountered this problem myself (may be due to new to poetry), so I want to remind users (who may be new to this, like me). However, I'm not sure if including this in the main README is necessary, so it's up to you whether or not to merge it.
[fmt] Third commit is recommended, which is a minor but meaningful formatting change (it was automatically formatted by my VSCode plugin, and I didn't notice this at first).

…s the installling of poetry.

coolermzb3 added 3 commits May 12, 2024 04:51

fix: missing [crucial] quotation mark in the code snippet, which fail…

49f1f19

…s the installling of poetry.

enh: add more clear documentation for poetry install --extras

91fa85a

fmt: tiny formatting on markdown table dashes

293d396

coolermzb3 changed the title ~~[Fix&Enhance&Format] On README.md~~ [Fix&Enhance&Format] On README.md about poetry install May 12, 2024

Trinkle23897 approved these changes May 23, 2024

View reviewed changes

Trinkle23897 merged commit 40a4ad1 into thu-ml:master May 23, 2024

Provide feedback