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

Use long form command-line argument for "self-documentation" #262

Merged
merged 1 commit into from
Dec 15, 2023

Conversation

nutjob4life
Copy link
Contributor

I recommend always using long-form command-line arguments (where available) in documentation. It helps make documentation more "documentary"

I recommend always using long-form command-line arguments (where available) in documentation. It helps make documentation more "documentary"
@lwasser
Copy link
Member

lwasser commented Dec 6, 2023

hey there @nutjob4life that is a good idea. maybe we can add a breakout box about using pip install -e . vs long form as well ?

may i ask - how did you find us here?

@lwasser
Copy link
Member

lwasser commented Dec 6, 2023

@all-contributors please add @nutjob4life for code, review

Copy link
Contributor

@lwasser

I've put up a pull request to add @nutjob4life! 🎉

@lwasser
Copy link
Member

lwasser commented Dec 6, 2023

the CI break is a small link issue that i fixed in another PR recently. so this can be merged once we decide we want to go this route (which i think makes sense i just want to get the communities input first!)

@nutjob4life
Copy link
Contributor Author

hey there @nutjob4life that is a good idea. maybe we can add a breakout box about using pip install -e . vs long form as well ?

may i ask - how did you find us here?

That's a good question! I'm not sure how I ended up here.

@lwasser
Copy link
Member

lwasser commented Dec 15, 2023

Merging this! thanks again @nutjob4life !!

@lwasser lwasser merged commit 251a70c into pyOpenSci:main Dec 15, 2023
2 of 3 checks passed
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.

2 participants