Open joel-foo opened 10 months ago
I acknowledge this could be a bit inconvenient for the user.
However, as mentioned, the information is available in the user guide. I believe the severity should not be medium.
Team chose [severity.Low
]
Originally [severity.Medium
]
Reason for disagreement: - Information on what kind of parameters are accepted must be present in the command format. Without them, users are left to "guess/infer" whether or not a command accepts certain parameters, which is quite a serious issue. They must be stated upfront, instead of letting the users guess from the examples or find it out themselves in some obscure part of the UG.
While the last bullet point mentions that you can modify the remark portion, there is no mention of how to do so, and what prefix should be used for it (user has to scroll all the way down). It is also not in the two examples provided.