honglinshang / pe

0 stars 0 forks source link

Instructions in help command wrong #6

Open honglinshang opened 1 year ago

honglinshang commented 1 year ago

et can be used without ed, as specified in the UG, but the help command contradicts that Screenshot 2023-04-14 at 4.48.15 PM.png Screenshot 2023-04-14 at 4.48.36 PM.png

soc-se-bot commented 1 year ago

Team's Response

In the help command, it is stated: ed and et are optional, but they must be written together if you use them.

In the user guide, it is stated:

ed and et are optional

The command in the user guide is more elaborate, however both instructions are consistent with each other.

This issue might also be classified wrongly as a functionality bug, I suppose documentation bug would fit better.

Items for the Tester to Verify

:question: Issue response

Team chose [response.Rejected]

Reason for disagreement: The instructions are inconsistent. Using et without ed is possible, but the message "ed and et are optional, but they must be written together if you use them" within the help command seems to indicate that you must use ed too if et were to be used.


## :question: Issue type Team chose [`type.DocumentationBug`] Originally [`type.FunctionalityBug`] - [x] I disagree **Reason for disagreement:** `help` message does not match the actual behaviour of the program