@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_>
Except that if there's a short and a long option for it, then you'd need to
duplicate the list of values. So I'd say lets just go with `<_FOO_>` everywhere
for these multi-value things - its just less format details to remember and get
wrong when writing manuals.
Actually, it's somewhat similar to using {} for single-line blocks in C: it
seems fine when you only have that single line, but once you need to add more,
you annoyingly need to touch the surrounding code too :sweat_smile:
--
Reply to this email directly or view it on GitHub:
https://github.com/rpm-software-management/rpm/pull/3639#discussion_r2005066532
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
