Skip to content

Commit 9aa1d75

Browse files
chore: use DIST_ANME in docs
- easier to read than NORMALIZED_DIST_NAME - addresses part of #986
1 parent b9d03e4 commit 9aa1d75

File tree

4 files changed

+9
-9
lines changed

4 files changed

+9
-9
lines changed

docs/config.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -157,7 +157,7 @@ Callables or other Python objects have to be passed in `setup.py` (via the `use_
157157
it is strongly recommended to use distribution-specific pretend versions
158158
(see below).
159159

160-
`SETUPTOOLS_SCM_PRETEND_VERSION_FOR_${NORMALIZED_DIST_NAME}`
160+
`SETUPTOOLS_SCM_PRETEND_VERSION_FOR_${DIST_NAME}`
161161
: used as the primary source for the version number,
162162
in which case it will be an unparsed string.
163163
Specifying distribution-specific pretend versions will

docs/integrations.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -47,7 +47,7 @@ build:
4747
- export SETUPTOOLS_SCM_OVERRIDES_FOR_${READTHEDOCS_PROJECT//-/_}='{scm.git.pre_parse="fail_on_shallow"}'
4848
```
4949

50-
This configuration uses the `SETUPTOOLS_SCM_OVERRIDES_FOR_${NORMALIZED_DIST_NAME}` environment variable to override the `scm.git.pre_parse` setting specifically for your project when building on ReadTheDocs, forcing setuptools-scm to fail with a clear error if the repository is shallow.
50+
This configuration uses the `SETUPTOOLS_SCM_OVERRIDES_FOR_${DIST_NAME}` environment variable to override the `scm.git.pre_parse` setting specifically for your project when building on ReadTheDocs, forcing setuptools-scm to fail with a clear error if the repository is shallow.
5151

5252
## CI/CD and Package Publishing
5353

@@ -67,7 +67,7 @@ These local version components (`+g1a2b3c4d5`, `+dirty`) prevent uploading to Py
6767

6868
#### The Solution
6969

70-
Use the `SETUPTOOLS_SCM_OVERRIDES_FOR_${NORMALIZED_DIST_NAME}` environment variable to override the `local_scheme` to `no-local-version` when building for upload to PyPI.
70+
Use the `SETUPTOOLS_SCM_OVERRIDES_FOR_${DIST_NAME}` environment variable to override the `local_scheme` to `no-local-version` when building for upload to PyPI.
7171

7272
### GitHub Actions Example
7373

@@ -287,9 +287,9 @@ publish-release:
287287

288288
#### Environment Variable Format
289289

290-
The environment variable `SETUPTOOLS_SCM_OVERRIDES_FOR_${NORMALIZED_DIST_NAME}` must be set where:
290+
The environment variable `SETUPTOOLS_SCM_OVERRIDES_FOR_${DIST_NAME}` must be set where:
291291

292-
1. **`${NORMALIZED_DIST_NAME}`** is your package name normalized according to PEP 503:
292+
1. **`${DIST_NAME}`** is your package name normalized according to PEP 503:
293293
- Convert to uppercase
294294
- Replace hyphens and dots with underscores
295295
- Examples: `my-package` → `MY_PACKAGE`, `my.package` → `MY_PACKAGE`

docs/overrides.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ setuptools-scm provides a mechanism to override the version number build time.
77
the environment variable `SETUPTOOLS_SCM_PRETEND_VERSION` is used
88
as the override source for the version number unparsed string.
99

10-
to be specific about the package this applies for, one can use `SETUPTOOLS_SCM_PRETEND_VERSION_FOR_${NORMALIZED_DIST_NAME}`
10+
to be specific about the package this applies for, one can use `SETUPTOOLS_SCM_PRETEND_VERSION_FOR_${DIST_NAME}`
1111
where the dist name normalization follows adapted PEP 503 semantics.
1212

1313
## pretend metadata
@@ -17,7 +17,7 @@ setuptools-scm provides a mechanism to override individual version metadata fiel
1717
The environment variable `SETUPTOOLS_SCM_PRETEND_METADATA` accepts a TOML inline table
1818
with field overrides for the ScmVersion object.
1919

20-
To be specific about the package this applies for, one can use `SETUPTOOLS_SCM_PRETEND_METADATA_FOR_${NORMALIZED_DIST_NAME}`
20+
To be specific about the package this applies for, one can use `SETUPTOOLS_SCM_PRETEND_METADATA_FOR_${DIST_NAME}`
2121
where the dist name normalization follows adapted PEP 503 semantics.
2222

2323
### Supported fields
@@ -82,7 +82,7 @@ export SETUPTOOLS_SCM_PRETEND_METADATA='{node="g1337beef", distance=4}'
8282

8383
## config overrides
8484

85-
setuptools-scm parses the environment variable `SETUPTOOLS_SCM_OVERRIDES_FOR_${NORMALIZED_DIST_NAME}`
85+
setuptools-scm parses the environment variable `SETUPTOOLS_SCM_OVERRIDES_FOR_${DIST_NAME}`
8686
as a toml inline map to override the configuration data from `pyproject.toml`.
8787

8888
## subprocess timeouts

docs/usage.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -221,7 +221,7 @@ Note that running this Dockerfile requires docker with BuildKit enabled
221221

222222
To avoid BuildKit and mounting of the .git folder altogether, one can also pass the desired
223223
version as a build argument.
224-
Note that `SETUPTOOLS_SCM_PRETEND_VERSION_FOR_${NORMALIZED_DIST_NAME}`
224+
Note that `SETUPTOOLS_SCM_PRETEND_VERSION_FOR_${DIST_NAME}`
225225
is preferred over `SETUPTOOLS_SCM_PRETEND_VERSION`.
226226

227227

0 commit comments

Comments
 (0)