Open Lalelulilulela opened 6 months ago
We placed it in a blue-coloured note as it is more striking to a readers eye, since a user glossing over the User Guide might miss the other statements that specify the range of the index accepted.
We also repeated it across commands as some users might just look through the UG for a guide to use a specific command, and would not read the guide for other commands. Repeating the note ensures that in such cases, the user does not miss it.
Team chose [response.Rejected
]
Reason for disagreement: While it is thoughtful of your team to use the blue-coloured note, I would still say that repeating the same thing so many times across different commands and even within each section is very redundant as it hinders readers in a way which slows them down. If the same thing is to be repeated so many times, I think it would be better to just have one note
at the start or at the end of the features
section to remind readers of it. Furthermore, the Note
that The index must be an integer in the displayed client list.
is very intuitive and should not need to be repeated so many times.
Repeating it within the same section right next to each other is just very redundant and slows down readers who may think that the note is something important but in fact it is something that they have already read.
Therefore, this should be a valid bug that should not be rejected.
"Note: The index must be an integer in the displayed client list." is intuitive and does not need to be shown so many times in the UG