Commit 7555d6dc by jtrakk Committed by GitHub

Rename secondary "tests" package in doc example (#2122)

If multiple distributions have `tests` as a top-level package, they'll conflict whenever both are installed. (Examples [here]((https://github.com/python-poetry/poetry/issues/1905) and [here](https://github.com/NixOS/nixpkgs/issues/81482). Two common alternative strategies are:

1. not distributing tests (as [here](https://github.com/pypa/sampleproject)), or 
2. placing tests in a subdirectory of the main package, rather than adjacent (as [here](http://blog.habnab.it/blog/2013/07/21/python-packages-and-you/) and [here](http://as.ynchrono.us/2007/12/filesystem-structure-of-python-project_21.html)). Each of these strategies will avoid this issue. 

Users may fall into this trap because of the [package documentation](https://python-poetry.org/docs/pyproject/#packages) page, which gives an example:

```
packages = [
    { include = "my_package" },
    { include = "tests", format = "sdist" },
]
```

Having two top-level packages in a distribution is relatively unusual, but does have some use cases.  Using `"tests"` as a top-level package name in the example is likely to lead to conflicts, however. The alternate package in the documentation example could have a unique name like `"my_other_package"`, which would reduce the likelihood of this kind of overlap.
parent fb4628c3
...@@ -131,11 +131,11 @@ it by using `format`: ...@@ -131,11 +131,11 @@ it by using `format`:
# ... # ...
packages = [ packages = [
{ include = "my_package" }, { include = "my_package" },
{ include = "tests", format = "sdist" }, { include = "my_other_package", format = "sdist" },
] ]
``` ```
From now on, only the `sdist` build archive will include the `tests` package. From now on, only the `sdist` build archive will include the `my_other_package` package.
!!!note !!!note
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment