-
-
Notifications
You must be signed in to change notification settings - Fork 4.2k
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
Encourage using long parameter options and mnemonic tags in our style guide #8304
Comments
We actually have documented that we prefer long options in CONTRIBUTING.md. But we should definitively move this to the style guide. |
@reinhart1010, long portable options are required now in style guide. Mnemonics are gonna to be allowed and mandated for everything, check out my PR. :) |
5 tasks
5 tasks
Fixed by #11619 |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
There's another two writing rules, undocumented on our style guide which we have also practiced instead in reviewing pull requests for new pages:
--verbose
instead of-v
) as possible,[v]erbose
)Which I personally liked, and in order to standardize how we should treat these cases we should put them in our style guide.
This is because most of our documented commands practiced at least one of these conventions:
cd {{path/to/directory}} /d
to switch directories.firefox --profile profile1 and git --help
.Invoke-WebRequest -Method Post -Body @{ name='bob' } http://example.com/form
Where many (1)-type commands may not introduce long parameter formats, as discussed on #8201, while some (2)-type commands also don't introduce long parameters as well, like in #8200. Here are some examples for the case of
slmgr.vbs
(#8201)Mnemonic tags aren't mandatory for translations as well. However, when including these tags into translations, make sure that the the tags do correspond to the same terms as in the English version or the original language where these short parameters correspond to the terms of the language (e.g.
[c]
for[c]arregar
in Portuguese-based programs).For example, in #8298,
The text was updated successfully, but these errors were encountered: