Make a brief mention in the documentation about the two forms for a CLI option with value
In the CLI, an option flag that accepts a value can be written in one of two ways.
-
It can be written using a single space between the option flag and the value:
--to-dir public
-
It can be written using an equals sign (
=
) between the option flag and the value:--to-dir=public
The docs (CLI reference page) should clarify that these two forms are both acceptable and equivalent. Which you choose is a matter of style. The CLI help text recommends using the first form. The docs should consistently do so as well. However, some people like to use the equals sign because it makes it more clear that the value belongs to the option. The docs need not say more than that on the matter.
For context, there's absolutely no consistency about which form is more correct. Even git interchanges the two forms when documenting a single command. We can expect users are familiar with these variations.