@dmnks commented on this pull request.


> +
+# OPTIONS
+Describe common options and in this section.
+
+Typographic conventions:
+- Put option aliases on separate lines
+- Put option arguments with pre-determined values into <> (see below)
+
+See *rpm.common*(8) for the options common to all *rpm* executables.
+
+*-d*,
+*--do-this*
+       Do Y instead of default action.
+
+*-o* _ARG_,
+*--output*=_ARG_

@ferdnyc's comments in the other thread made me realize we should actually name 
the placeholders by what they represent, i.e. `_FILE_` in this case. It makes 
referring to the argument more natural when describing it, too. 

For example:

Current style:
```
*--output*=_ARG_
        Use file _ARG_ for output.
```

Proposed style:
```
*--output*=_FILE_
        Use _FILE_ for output.
```

-- 
Reply to this email directly or view it on GitHub:
https://github.com/rpm-software-management/rpm/pull/3639#pullrequestreview-2699304249
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

Reply via email to