nus-cs2103-AY2122S2 / pe-dev-response

0 stars 0 forks source link

Example does not match screenshot #3311

Open nus-pe-bot opened 2 years ago

nus-pe-bot commented 2 years ago

Note from the teaching team: This bug was reported during the Part II (Evaluating Documents) stage of the PE. You may reject this bug if it is not related to the quality of documentation.


Under the mark feature in the UG, the example states that index 2 is marked but the screenshot highlights index 4 instead which may confuse the reader

image.png


[original: nus-cs2103-AY2122S2/pe-interim#3271] [original labels: severity.Low type.DocumentationBug]

sbhbenjamin commented 2 years ago

Team's Response

As there is still a clear red outline of the task that is marked, the caption plays more of an assistive role rather than a primary role in explaining the feature to the user. As such, we recognise that there is an error here, as a severity of veryLow.

Duplicate status (if any):

--