-
-
Notifications
You must be signed in to change notification settings - Fork 404
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
doc: Correct a typo in project.md #2212
Conversation
docs/docs/usage/project.md
Outdated
@@ -74,7 +74,7 @@ Although PDM run on Python 3.7 and above, you can still have lower Python versio | |||
| `flit-core>=3.4` | `>=3.6` | Yes | | |||
| `flit-core>=3.2,<3.4` | `>=3.4` | Yes | | |||
|
|||
Note that if your project is an application(without `name` metadata), the above limitation of backends don't apply, since you don't need a build backend after all, and you can use a Python version up to `2.7`. | |||
Note that if your project is an application(without `name` metadata), the above limitation of backends don't apply, since you don't need a build backend after all, and you can use a Python version up to `3.7`. |
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.
I think it should be "down to 2.7". Or it should explicitely tell the possible versions.
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.
Yes, the section is badly worded in general. In reality, if a backend is not applicable then any version of python could be used, right?
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.
I guess so 🤔
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.
Yes, the section is badly worded in general. In reality, if a backend is not applicable then any version of python could be used, right?
No, but >=2.7 at least, or some in-process scripts don't work
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.
Then "down to 2.7" is more accurate. I'll reword that paragraph to improve the general wording and take that constraint into account.
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.
Done. Let me know if you prefer I rebase onto main
.
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.
The only thing left to consider with this section is that it contradicts the fact that one needs >= 3.7 to use PDM in the first place.
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.
PDM runs on Python >= 3.7, but an application project can support Python >= 2.7, and you'll still be able to manage its dependencies with PDM.
docs/docs/usage/project.md
Outdated
@@ -74,7 +74,8 @@ Although PDM run on Python 3.7 and above, you can still have lower Python versio | |||
| `flit-core>=3.4` | `>=3.6` | Yes | | |||
| `flit-core>=3.2,<3.4` | `>=3.4` | Yes | | |||
|
|||
Note that if your project is an application(without `name` metadata), the above limitation of backends don't apply, since you don't need a build backend after all, and you can use a Python version up to `2.7`. | |||
Note that if your project is an application (i.e. without the `name` metadata), | |||
the above limitation of backends does not apply. Therefore, if you don't need a build backend you can use any Python version `≥2.7`. |
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.
For consistency and copy/pastability:
the above limitation of backends does not apply. Therefore, if you don't need a build backend you can use any Python version `≥2.7`. | |
the above limitation of backends does not apply. Therefore, if you don't need a build backend you can use any Python version `>=2.7`. |
Pull Request Checklist
- [ ] A news fragment is added innews/
describing what is new.- [ ] Test cases added for changed code.Describe what you have changed in this PR.
Corrected a typo in project.md.
Added change to commit #2210 requested by @pawamoy after review.