@dmnks 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_>
Yeah, I'm starting to think we should just use the allcaps placeholder *also*
for enum-like options, for simplicity. It *is* a placeholder after all, just
one with a limited set of accepted values. That's the job of the option's
description, to describe what the option does and what argument value, if any,
is accepted.
That means:
```
*--compress*=_METHOD_
```
In other words, by skimming through the man page, you don't really need to know
precisely which options have limited argument values, that's what you learn by
actually reading the desired option's description.
--
Reply to this email directly or view it on GitHub:
https://github.com/rpm-software-management/rpm/pull/3639#discussion_r2003792856
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
