Skip to content
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

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

Merged
merged 3 commits into from
May 23, 2024

Conversation

coolermzb3
Copy link
Contributor

  • 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

  1. [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.
  2. [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.
  3. [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).

@coolermzb3 coolermzb3 changed the title [Fix&Enhance&Format] On README.md [Fix&Enhance&Format] On README.md about poetry install May 12, 2024
@Trinkle23897 Trinkle23897 merged commit 40a4ad1 into thu-ml:master May 23, 2024
4 checks passed
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.

None yet

2 participants