python / importlib_metadata

Library to access metadata for Python packages
https://importlib-metadata.readthedocs.io
Apache License 2.0
123 stars 80 forks source link

Clarify import vs. distribution packages in Using importlib_metadata docs #399

Closed CAM-Gerlach closed 1 year ago

CAM-Gerlach commented 2 years ago

As requested on the Python Discourse, addresses #398 (import vs. distribution packages not being clear) by:

Additionally, this incorporates a couple required/directly related changes:

Fix #398

Reviewer notes:

[^unsure]: I'm not 100% sure myself about the disambiguations in the highly technical Extending the search algorithm Explanation—please check to confirm I've gotten them correct.

[^termlinks]: So readers don't have to go hunting through other sections to find them, if they do so at all

[^intersphinx]: If this needs to go in your skeleton, I can submit a PR there, drop that commit here and rebase accordingly once that is updated. Also, I was confused by some were written as dict literals, and some were added with dict.update, with no obvious or stated reason—I though it might have to do with the former being from your skeleton and the latter being local, but your skeleton looks identical, so I'm not sure what's going on or where packaging.python.org. Please advise and I'll be happy to add it in whichever manner is appropriate.

[^coremetadata]: If required, I can pull this out to a separate followup PR, though it is small enough I just added it here to avoid extra overhead on both our parts.

CAM-Gerlach commented 1 year ago

Hey @jaraco sorry for missing this and thanks for taking care of it; I was extremely busy for the Artemis 1 launch attempts during this time and then must have accidentally dismissed it (I believe I mistakenly thought it was a different unrelated issue rather than this PR). You shouldn't have to, but in the future you're welcome to give me a ping on Discord, etc. just in case I miss something like this in the future, so you don't have to wait around for a month and then have to do it yourself. Thanks!