Skip to content
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.

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

Rename "develop" option to "editable" #3004

Open
1 of 6 tasks
abn opened this issue Sep 30, 2020 · 4 comments
Open
1 of 6 tasks

Rename "develop" option to "editable" #3004

abn opened this issue Sep 30, 2020 · 4 comments
Assignees
Labels
kind/enhancement Not a bug or feature, but improves usability or performance kind/feature Feature requests/implementations

Comments

@abn
Copy link
Member

abn commented Sep 30, 2020

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.
  • Add --editable option directory and vcs dependencies to poetry add command. (This can be an issue on its own.)
@abn abn added kind/feature Feature requests/implementations kind/enhancement Not a bug or feature, but improves usability or performance labels Sep 30, 2020
@0scarB
Copy link

0scarB commented Oct 20, 2020

@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

@finswimmer
Copy link
Member

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

@odravison
Copy link

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

@dimbleby
Copy link
Contributor

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.

@Secrus Secrus self-assigned this Sep 25, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
kind/enhancement Not a bug or feature, but improves usability or performance kind/feature Feature requests/implementations
Projects
None yet
Development

No branches or pull requests

6 participants