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 options instead of short ones #1349

Closed
wants to merge 1 commit into from
Closed

Use long options instead of short ones #1349

wants to merge 1 commit into from

Conversation

clemens-tolboom
Copy link
Contributor

It is a little hard to learn what the options mean.

@stale
Copy link

stale bot commented Feb 13, 2021

I marked this as stale due to inactivity. → More info

@stale stale bot added the stale label Feb 13, 2021
@clemens-tolboom
Copy link
Contributor Author

Hmmm ... thanks @Stale to poke me. Will check soon.

@stale stale bot removed the stale label Feb 13, 2021
@clemens-tolboom
Copy link
Contributor Author

So the quickstart (and more?) are moved from .xml into .md

Commit: e0ea3c8 [e0ea3c8]
Parents: 650ae14
Author: Eelco Dolstra edolstra@gmail.com
Date: 22 July 2020 at 20:27:23 CEST
Commit Date: 23 July 2020 at 18:26:48 CEST

which got merged in

Commit: b721877 [b721877]
Parents: ebb8e07, 50f4683
Author: Eelco Dolstra edolstra@gmail.com
Date: 1 September 2020 at 10:31:17 CEST
Committer: GitHub noreply@github.com

@stale
Copy link

stale bot commented Aug 13, 2021

I marked this as stale due to inactivity. → More info

@stale stale bot added the stale label Aug 13, 2021
@clemens-tolboom
Copy link
Contributor Author

Not sure how to trigger tests :-/

@stale stale bot removed the stale label Aug 22, 2021
@vcunat
Copy link
Member

vcunat commented Aug 22, 2021

I don't think tests are really relevant to such a trivial documentation change. I'm personally not sure if using long forms is preferable in docs. Perhaps some of "real" maintainers have a strong opinion on this.

If I wanted to learn what the options mean, I'd look into the corresponding man page. And when I type into console I almost always use the short options. In scripts I would probably prefer long ones, though...

@clemens-tolboom
Copy link
Contributor Author

If I wanted to learn what the options mean, I'd look into the corresponding man page. And when I type into console I almost always use the short options. In scripts I would probably prefer long ones, though...

If you don't want to help new users onboarding please do keep the short options in the documentatation.

Making them long would have helped me a lot faster learning new/unfamiliar tools.

@Ericson2314
Copy link
Member

This seems like a good idea. Start with long, and once you get tired of typing, switch to old.

@fricklerhandwerk
Copy link
Contributor

@clemens-tolboom sorry for the long waiting time. Are you still interested in merging this? Please rebase so we can proceed.

@clemens-tolboom
Copy link
Contributor Author

@fricklerhandwerk I pass ... I removed my clone and am not using nix anymore. I rerolled it Feb 13, 2021 hope someone can redo this on

@Ericson2314
Copy link
Member

Ericson2314 commented Nov 9, 2022

Behold, everyone, how we've abandon PRs chasing people off!

May we finally be turning a new leaf.

@Ericson2314
Copy link
Member

#7864 I have rebased it.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

6 participants