poetry icon indicating copy to clipboard operation
poetry copied to clipboard

Rename "develop" option to "editable"

Open abn opened this issue 5 years ago • 4 comments

We should rename the dependency option develop to editable to align with what it actually is and to avoid confusion with a "development dependency".

- foo = { path = "./path/to/foo", develop = true }
+ foo = { path = "./path/to/foo", editable = true }

Additionally we should also introduce this as a commandline option to poetry add (eg: poetry add --editable x).

Changes Required

  • [ ] Update specification schema in poetry-core.
  • [ ] Update dependency instances to reference editable and fallback to develop if not present.
  • [ ] Update references to Dependency.develop in both poetry-core and poetry.
  • [ ] Add deprecation warning when accessing Dependency.develop.
  • [ ] Add poetry check warning to inform users about the change.
  • [x] Add --editable option directory and vcs dependencies to poetry add command. (This can be an issue on its own.)

abn avatar Sep 30 '20 14:09 abn

@python-poetry/triage I wouldn't mind working on this, given I've gained a bit of knowledge working on #3220. I could also fix the issue of the bad error message mentioned in #3220

0scarB avatar Oct 20 '20 11:10 0scarB

Feel free to start working on the other points and ping us if we should give feedback. :+1:

finswimmer avatar Oct 23 '20 18:10 finswimmer

I came here because I've been confused about this name. Would be a good thing do that change

odravison avatar Sep 28 '23 15:09 odravison

this issue has been dormant for three years. I think it's safe to say that if you care to see this happen: you'll need to make this happen.

dimbleby avatar Sep 28 '23 21:09 dimbleby