@pmatilai commented on this pull request.
> +Typographic conventions:
+- Put option aliases on separate lines
+- Put option arguments with pre-determined values into <> (see below)
+
+*-d*
+*--do-this*
+ Do Y instead of default action.
+
+*-o* _ARG_,
+*--output*=_ARG_
+ Use file _ARG_ for output.
+
+*--format*=<*aa*|*bb*>
+ Use format *aa* or *bb* for output.
+
+*--compress*=<_method_>
Thanks for the comments.
We *are* using the traditional all caps for generic argument placeholders, as
per tradition (that is something we value quite a bit). The idea here is to
differentiate between multivalue and arbitrary value arguments using the
limited tricks available, in particular for the case where there are too many
to list in the `<aa|bb|cc>` style. The CATEGORY in `--warnings=CATEGORY` *is* a
placeholder, so to me it makes sense to use similar markup.
Whether lowercase vs uppercase is a good indicator of that, I don't know. The
current template actually uses two clues for that: `*--compress*=<_method_>` -
so its both lowercase and also surrounded by `<>`. Just the latter with
uppercase arg would probably work equally well, ie `*--compress*=<_METHOD_>`.
--
Reply to this email directly or view it on GitHub:
https://github.com/rpm-software-management/rpm/pull/3639#discussion_r2000408801
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
