search

nus-cs2103-AY2122S1 / pe-dev-response

0 stars 0 forks source link

Format error for edit exam #4927

Open nus-pe-bot opened 3 years ago

nus-pe-bot commented 3 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.

image.png

The format for edit exam is incorrect as 3 should be INDEX instead. However, this error might cause the user to unable to use this function at all as they might be confused as of where INDEX should be included.

[original: nus-cs2103-AY2122S1/pe-interim#4923] [original labels: severity.Medium type.DocumentationBug]

itzblim commented 3 years ago

Team's Response

While this is indeed an error, we believe the severity should be LOW as users can easily deduce from the context that the value should represent an index, based on the elaboration stated below ("Edits the exam at the specified INDEX").

Furthermore, the neighbouring index-based commands all have the correct format, so users should be able to discern that the value 3 is an index, and should not hinder usage severely.

Duplicate status (if any):

--