Command does not work as described by ug

[nickeltea]

The given example command as can be seen in the screenshot above cannot be executed.

Since the feature does not work as specified, this is a funcitonality bug.

[nus-pe-script]

Team's Response

Hi, thanks for the bug report!

This is indeed a bug. However, we feel it is a documentation bug as our UG misses to include the -n flag before the name.

Try running edit task 1 -n "Merge PR" -a 1 -d 2022-12-02 23:59 and it should work!

Changing the bug type to documentation to reflect to the same.

Also, it is a low severity bug because our app prompts the user to run edit task --help which shows the correct format for using the command :) Here's what it looks like: (notice that the help message shown includes the -n tag and the correct format)

Have a nice reading week ahead!

The 'Original' Bug

[The team marked this bug as a duplicate of the following bug]

The edit task command example given in the user guide does not work as described

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.

---

As can be seen in the screenshot above, the command "edit task 1 "Merge PR" -a 1 -d 2022-12-02 23:59" is provided as an example but is unable to execute despite a valid task index being provided.

The user guide is innacurate.

---

_{[original: nus-cs2103-AY2223S1/pe-interim#3643] [original labels: type.DocumentationBug severity.Low]}

Their Response to the 'Original' Bug

[This is the team's response to the above 'original' bug]

Hi, thanks for the bug report!

We accept this bug :) Good catch! (We missed the -n flag)

Items for the Tester to Verify

:question: Issue duplicate status

Team chose to mark this issue as a duplicate of another issue (as explained in the Team's response above)

• [ ] I disagree

Reason for disagreement: [replace this with your explanation]

---

:question: Issue type

Team chose [type.DocumentationBug] Originally [type.FunctionalityBug]

• [ ] I disagree

Reason for disagreement: [replace this with your explanation]

---