Skip to content

docs: Explain editable VCS dependencies - #11124

Open
Mohamedajab wants to merge 2 commits into
python-poetry:mainfrom
Mohamedajab:docs/editable-vcs-dependencies
Open

Mohamedajab wants to merge 2 commits into
python-poetry:mainfrom
Mohamedajab:docs/editable-vcs-dependencies

Conversation

@Mohamedajab

Copy link
Copy Markdown
Contributor

Pull Request Check List

Resolves: #6390

  • Added tests for changed code. (Not applicable: documentation-only change.)
  • Updated documentation for changed code.

Summary

Explain where Poetry places an editable VCS checkout, how edits become import-visible, and why users should treat the virtual-environment checkout as Poetry-managed. Recommend an editable path dependency for simultaneous development across two projects.

Validation

  • git diff --check
  • cross-checked the documented checkout location against the editable Git installation tests

@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 ✨

This branch has not been deployed

No deployments
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.

What does it actually mean to install a git dependency in editable mode?

1 participant