Skip to content

docs: clarify path dependency portability - #11020

Open
nightcityblade wants to merge 1 commit into
python-poetry:mainfrom
nightcityblade:docs/issue-6752
Open

docs: clarify path dependency portability#11020
nightcityblade wants to merge 1 commit into
python-poetry:mainfrom
nightcityblade:docs/issue-6752

Conversation

@nightcityblade

Copy link
Copy Markdown

Pull Request Check List

Resolves: #6752

  • Added tests for changed code. N/A — documentation-only change.
  • Updated documentation for changed code.

Summary

Clarify that path dependencies are intended for local development and remain
non-portable in built distributions because Poetry records them as file://
requirements. Recommend publishing the dependency and replacing the path with a
version constraint before distribution.

Validation

  • pre-commit run --files docs/dependency-specification.md
  • Built the documentation with the python-poetry/website build script.
  • Built the static website with Hugo and verified the rendered note.
  • Reproduced the behavior with Poetry by inspecting wheel and sdist metadata.

@sourcery-ai sourcery-ai Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Hey - I've reviewed your changes and they look great!

Sourcery assessment

Approved.


Sourcery is free for open source - if you like our reviews please consider sharing them ✨
Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Better documentation for path dependencies.

1 participant