Skip to content

Documenting SETUPTOOLS_SCM_PRETEND_VERSION_FOR_${NORMALIZED_DIST_NAME} #981

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.

Sign up for GitHub

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

Jump to bottom
Merged
merged 1 commit into from
Dec 3, 2023
Merged

Documenting SETUPTOOLS_SCM_PRETEND_VERSION_FOR_${NORMALIZED_DIST_NAME} #981

merged 1 commit into from
Dec 3, 2023

Conversation

jamesbraza
Copy link
Contributor

Resolves #978
jamesbraza
jamesbraza commented Nov 20, 2023
View reviewed changes
docs/config.md
in which case it will be an unparsed string
: used as the primary source for the version number,
in which case it will be an unparsed string.
Specifying distribution-specific pretend versions will
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can I say something like "distribution-specific (aka package-specific)"
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm wondering if it perhaps should change to python package name to disambiguate
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Do you mean in the docs, or in the docs and source code?

For convenience, #500 and #509 are the relevant PRs
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

for parity, as a followup
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I finally got around to this today, and concluded:

  1. The term "distribution" is all over the Python docs (e.g. importlib.metadata, legacy install docs, setuptools docs)
  2. "dist" is also all over the place in the source code here

So I think it's fine to stick with the terminology "distribution" here after all. I am going to skip on opening a PR to change the wording from "dist" to "pkg"
@RonnyPfannschmidt RonnyPfannschmidt mentioned this pull request Dec 3, 2023
Closed
2 tasks
@RonnyPfannschmidt RonnyPfannschmidt merged commit c395c91 into pypa:main Dec 3, 2023
@jamesbraza jamesbraza deleted the documenting-dist-names branch December 3, 2023 20:17
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

2 participants

@jamesbraza @RonnyPfannschmidt