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

Decide on foreman-installer "--option=true" vs --option true" #2881

Open
maximiliankolb opened this issue Mar 13, 2024 · 4 comments
Open

Decide on foreman-installer "--option=true" vs --option true" #2881

maximiliankolb opened this issue Mar 13, 2024 · 4 comments

Comments

@maximiliankolb
Copy link
Contributor

original comment: https://github.com/theforeman/foreman-documentation/pull/2825/files#r1521916088

Tested successfully on Foreman 3.9:

$ foreman-installer --foreman-proxy-dhcp true
$ foreman-installer --foreman-proxy-dhcp=true

I propose that we pick one way over the other and make it consistent throughout the docs.

@adamlazik1
Copy link
Contributor

I'd probably prefer = to be more explicit. No strong opinions, though.

@asteflova
Copy link
Contributor

I like = too. Subjectively, it seems to me that it makes the connection between the option and the value obvious at first glance.

For the sake of completeness: I tried to find an objective reason to pick one over the other by searching the style guides we use d/s, but I didn't find any guidance there.

@Lennonka
Copy link
Contributor

Lennonka commented Mar 13, 2024

I would prefer a space, because it makes it visually easier to scan the command line.

@ekohl
Copy link
Member

ekohl commented Mar 13, 2024

I vaguely recall that for hash arguments the = handling was broken. So passing --my-hash-argument key:value would work but --my-hash-argument=key:value wouldn't. However, I can't find a bug report on that.

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

5 participants