Open germainelee02 opened 1 year ago
This DocumentationBug is accepted, but at a Low severity. The issue is unlikely to affect normal operations of the product, as users can easily refer to the more specific section with the full command syntax. As such, while the inconsistency could be confusing, its unlikely to be a problem beyond a minor inconvenience.
Team chose [severity.Low
]
Originally [severity.Medium
]
Reason for disagreement: I disagree. In the case where experienced users would just skip to the command summary, they would realise that the format given in the command summary table is vastly different from the one actually provided. Not only is it vague, it does not match the actual commands at all.
I believe that this would confuse a lot of users to just skip to the command summary table. You did not state what is KEYWORDS
. Also, what is MORE_KEYWORDS
?
I believe that this should be a severity.Medium
because the command format is so vastly different from what it actually is
Very confusing why there are two formats in the command summary and in the actual command