search

nus-cs2103-AY2324S2 / pe-dev-response

0 stars 0 forks source link

Flow of commands not coherent in the UG #765

Open nus-pe-bot opened 5 months ago

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

The UG command summary does not give commands that are coherent with one another, for example,

Screenshot 2024-04-19 at 5.13.46 PM.png

If the commands are run sequentially, they would result in invalid errors as they are not coordinated. if the user runs the following command order:

  1. add n/James Ho p/22224444 e/jamesho@example.com a/123, Clementi Rd, 1234665 t/friend t/colleague b/01/01/2001 d/monday $/100

  2. clear

3.delete 3 -> invalid example as index 3 does not exist in the address book

  1. edit 2 n/James Lee e/jameslee@example.com -> invalid example as index 2 does not exist in the addressbook.

Perhaps, the team can reorganise the UG command summary for the ease of testing of the users and more organised command lines. Regards!

[original: nus-cs2103-AY2324S2/pe-interim#983] [original labels: type.DocumentationBug severity.VeryLow]

zhekaiii commented 5 months ago

Team's Response

The command summary is not meant to suggest to the reader to run the commands in any sequence. It is meant as a "cheat sheet" that users can refer to.

Duplicate status (if any):

--