Skip to content

Commit 3e78288

Browse files
lwasserNickleDave
andcommitted
Fix: Apply suggestions from code review
Apply suggestions from code review Update package-structure-code/python-package-build-tools.md Co-authored-by: Randy Döring <[email protected]> Update package-structure-code/python-package-build-tools.md Co-authored-by: Randy Döring <[email protected]> Update package-structure-code/python-package-build-tools.md Co-authored-by: Randy Döring <[email protected]> Update package-structure-code/python-package-distribution-files-sdist-wheel.md Co-authored-by: David Nicholson <[email protected]>
1 parent 755cdd5 commit 3e78288

File tree

2 files changed

+5
-5
lines changed

2 files changed

+5
-5
lines changed

package-structure-code/python-package-build-tools.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -396,7 +396,7 @@ Poetry is user-friendly and has clean and easy-to-read documentation.
396396

397397
```{note}
398398
While some have used Poetry for Python builds with C/C++ extensions, this support
399-
is currently undocumented. Thus we don't recommend it for more complex builds.
399+
is currently undocumented. Thus, we don't recommend using Poetry for more complex builds.
400400
```
401401

402402
### Poetry features
@@ -421,8 +421,8 @@ Build your SDist and wheel distributions,✅,
421421

422422
Some challenges of Poetry include:
423423

424-
* Poetry pins dependencies using an "upper bound" limit specified with the `^` symbol. See breakout below for more regarding why this is potentially problematic.
425-
* Doesn't support version control based versioning
424+
* Poetry pins dependencies using an "upper bound" limit specified with the `^` symbol by default. See breakout below for more regarding why this is potentially problematic.
425+
* Doesn't support version control based versioning without a plugin
426426
* *Minor:* The way Poetry currently adds metadata to your pyproject.toml file does not does not follow current Python standards. However, this is going to be addressed when they release version 2.0.
427427

428428
Poetry is an excellent tool. Use caution when pinning dependencies as
@@ -434,7 +434,7 @@ discusses the slight differences in how poetry adds deps....-->
434434
```{admonition} Challenges with Poetry dependency pinning
435435
:class: important
436436
437-
Poetry pins dependencies using `^`. This `^` symbol means that there is
437+
Poetry pins dependencies using `^` by default. This `^` symbol means that there is
438438
an "upper bound" to the dependency. Thus poetry will bump a dependency
439439
version to a new major version. Thus, if your package uses a dependency that
440440
is at version 1.2.3, Poetry will never bump the dependency to 2.0 even if

package-structure-code/python-package-distribution-files-sdist-wheel.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
There are two core distribution files
44
that you need to create to publish your Python package to
5-
PyPI SDist and Wheel. The SDist (Source Distribution) contains the raw source
5+
PyPI source distribution (often called an sdist) and wheel. The SDist contains the raw source
66
code for your package. The Wheel (.whl) contains the built / compiled files
77
that can be directly installed onto anyones' computer.
88

0 commit comments

Comments
 (0)