@dmnks commented on this pull request.
> +Put distinct operational modes to their own subsections.
+
+Typographic conventions:
+- Use bold for literal values such as command name and options:
+*cmd* does X, with option *--do-this* does Y instead
+- Use underline uppercase to denote user arguments: _ARGUMENT_
+- Use underline for literal file names: _hello-1.0-1.noarch.rpm_
+- Put an empty line before a new section/option/etc
+- Put text immediately below a section/option/etc (ie without an empty line)
+- Put optional elements into [] brackets
+- Put one-of-many choices into <val1|val2|val3> lists
+- Do not emphasize separators like ",", "=", "[]", "|"
+
+When in doubt, consult *man-pages*(7).
+
+# OPTIONS
> Hmm, otoh maybe the MODE in the titles is just reduntant, it "breaks" the
> link between these descriptions and the section name:
>
> ```
> *rpm* {*-q*|*--query*} [select-options] [query-options] [_PACKAGE_FILE_ ...]
> [_PACKAGE_NAME_ ...]
> ```
Oh, I missed this comment. It partially explains why not use "mode", okay then
:smile: Yep, I kinda agree, although I'm still not sure if calling modes as
"options" is the best idea...
--
Reply to this email directly or view it on GitHub:
https://github.com/rpm-software-management/rpm/pull/3639#discussion_r1984958488
You are receiving this because you are subscribed to this thread.
Message ID: <rpm-software-management/rpm/pull/3639/review/[email protected]>_______________________________________________
Rpm-maint mailing list
[email protected]
https://lists.rpm.org/mailman/listinfo/rpm-maint
