search

derekjxtan / pe

0 stars 0 forks source link

Add command potential errors are hidden in the UG #16

Open derekjxtan opened 9 months ago

derekjxtan commented 9 months ago

PDF version of UG does not show potential errors. Actually its the same for every section but ill only report it once.

image.png

soc-pe-bot commented 9 months ago

Team's Response

No details provided by team.

The 'Original' Bug

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

User Guide appears to have hidden sections

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.

image.png

For the Potential Errors section of commands like Add, Edit etc., the dropdown section of the Potential Errors section seem to be unexpanded and not included in the User Guide, or does not contain any content and thus should be excluded from the User Guide. As a result, potential errors of commands due to invalid or missing parameters are not shown to the user.

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

Their Response to the 'Original' Bug

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

From Professor Damith:

c5d0c03a-6c95-4c1d-942b-fcfea5ec4dc8.png

We admittedly uploaded the wrong version of the UG to the submission portal, and so we immediately emailed Professor Damith about it. This is a non error as the UG should not contain it anyway.

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 explanation]

## :question: Issue response Team chose [`response.Rejected`] - [ ] I disagree **Reason for disagreement:** [replace this with your explanation]
## :question: Issue severity Team chose [`severity.VeryLow`] Originally [`severity.Low`] - [ ] I disagree **Reason for disagreement:** [replace this with your explanation]