search

nus-cs2113-AY2223S1 / pe-dev-response

0 stars 0 forks source link

Documentation for Edit Expense could be improved #848

Open nus-pe-bot opened 1 year ago

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

Screenshot 2022-11-11 at 5.29.30 PM.png

As it can be seen in the picture above, there are so many ways that one can write a command to edit-expense using the different flags.

Screenshot 2022-11-11 at 5.30.16 PM.png

However, only 2 examples have been shown, which lacks clarity to the user on the full usage of the functionality. This could be improved by providing an example for each of the edit-expense with different flags.

[original: nus-cs2113-AY2223S1/pe-interim#821] [original labels: severity.Low type.DocumentationBug]

xzynos commented 1 year ago

Team's Response

Greetings karthikstar,

Thank you for your bug report. After careful evaluation of your bug report, the development team is rejecting this bug report due to the following reasons:

1) Due to large number of different combinations, it is just not feasible to add a sample output for every combination of arguments for the command Edit-Expense.

2) The reported issue does not affect the functionality of the user guide and we are not accepting suggestions as bugs.

Regards, xzynos

Duplicate status (if any):

--