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

Editable vs. -e? #94

Open
henryiii opened this issue Jul 17, 2024 · 1 comment
Open

Editable vs. -e? #94

henryiii opened this issue Jul 17, 2024 · 1 comment

Comments

@henryiii
Copy link
Collaborator

henryiii commented Jul 17, 2024

I've noticed the fully-written-out version the editable flag, pip install --editable ".[test]", being used. I've pretty much never seen this, even in CI, where it's usually advised to use long-form flags. Given it's something you tend to run a lot (say for compiled code, where you need to rebuild, or just in general every time you make a venv), wouldn't it be better to use the common form, pip install -e ".[test]", and just mention it has a long --editable version instead?

Note that git commit -m is used, not git commit --message.

@hollandjg
Copy link
Collaborator

I think that the long-form reduces the cognitive load, and that's something we need to do as much as possible given the material and the short time we have.

(I'd honestly not noticed that -m because I've used it for years and it's obvious to me, but I think that's something I need to be more careful of. There were other sessions which touched on git so I think we'll just leave that – I think everyone will understand -m, whereas -e/--editable is completely new.)

We mention the --editable/-e equivalency the first time the flag is used, and I think we'll keep it that way for tomorrow.

There's no reason not to change it back if that's preferable after we've given this year's workshop!

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

No branches or pull requests

2 participants