nus-cs2103-AY2021S1 / pe-dev-response

0 stars 0 forks source link

UG: not enough elaboration for examples #4982

Open nus-pe-bot opened 4 years ago

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


For the addl feature in UG, the last 3 examples were not elaborated at all. This got me really confused as to what the examples intended output should be. For example, in the case of "l/d/08/10/2020 d/10/10/2020 l/d/20/10/2020" does this mean that there will be 3 dates added as the leave or 1 continuous long leave and 1 separate day leave? While this may seem intuitive to the team, as a new user of Eva, it was especially confusing with 3 dates in the command and unfamiliarity with the prefixes used.

Screenshot 2020-11-13 at 5.22.40 PM.png


[original: nus-cs2103-AY2021S1/pe-interim#4850]

IsaacTin commented 4 years ago

Team's Response

The format of the command is already explained in the tip box above. These are merely examples for user to try out, and not supposed to be an explanation of how the command works as it has already been explained before. This is also changed to very low because of this reason as well.

Duplicate status (if any):

--