search

kennethk-1201 / pe

0 stars 0 forks source link

Irrelevant content in DG. #11

Open kennethk-1201 opened 1 year ago

kennethk-1201 commented 1 year ago

Screenshot 2023-04-14 at 3.24.20 PM.png

The "more test cases" points are not relevant and should be removed.

soc-se-bot commented 1 year ago

[IMPORTANT!: Please do not edit or reply to this comment using the GitHub UI. You can respond to it using CATcher during the next phase of the PE]

Team's Response

No details provided by team.

The 'Original' Bug

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

Developer Guide: Incomplete features added in list order

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.

"3. more test cases" is unclear if that is a test case, or a test case that is going to be added later, as it is included in the list sequence numbering.

"More Test cases will be added in the future." would be clearer.

Screenshot 2023-04-14 at 3.29.24 PM.png

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

Their Response to the 'Original' Bug

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

We don't believe that this hinders understanding.

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)

Reason for disagreement: [replace this with your reason]

## :question: Issue response Team chose [`response.Rejected`] - [x] I disagree **Reason for disagreement:** Documentation should be minimal but sufficient. Even if it doesn't hinder understanding, it's taking up space for no reason and hence it is not minimal. If this line adds value, so as to tell the reader there are "more potential test cases", then the test cases should be done for all the other commands.