From 4a32c2f4d7dca2be1ff82d14759d6e257d75ecdb Mon Sep 17 00:00:00 2001 From: Anderson Bravalheri Date: Fri, 10 Jun 2022 13:24:39 +0100 Subject: Improve choice of words --- docs/references/keywords.rst | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) (limited to 'docs') diff --git a/docs/references/keywords.rst b/docs/references/keywords.rst index 76fb014a..0b8c0c57 100644 --- a/docs/references/keywords.rst +++ b/docs/references/keywords.rst @@ -196,7 +196,7 @@ extensions). ``package_dir`` A dictionary that maps package names (as the developer wishes they would be imported by the end-users) into directory paths (that actually exist in the - project's source tree). This configuration can be used with 2 main objectives: + project's source tree). This configuration can be used with 2 main purposes: 1. To effectively "rename" paths when building your package. For example, ``package_dir={"mypkg": "dir1/dir2/code_for_mypkg"}`` @@ -206,11 +206,11 @@ extensions). .. attention:: While it is *possible* to specify arbitrary mappings, developers are **STRONGLY ADVISED AGAINST** that. They should try as much as possible - to keep the directory names and structure identical to as they would + to keep the directory names and hierarchy identical to as they would appear in the final wheel, only deviating when absolutely necessary. - 2. To indicate that the code corresponding to a package implementation is - entirely contained inside a specific directory. + 2. To indicate that the relevant code is entirely contained inside + a specific directory (instead of directly placed under the project's root). In this case, a special key is required (the empty string, ``""``), for example: ``package_dir={"": ""}``. All the directories inside the container directory will be copied -- cgit v1.2.1