choowengyan / pe

0 stars 0 forks source link

Inconsistency in Documentation for `ViewClientCommand` on DG #16

Open choowengyan opened 2 months ago

choowengyan commented 2 months ago

As shown in the screenshot below, the heading of the ViewClientCommand is being separated into different pages as the explanation, causing inconvenience to the reader when reading it.

Besides, bullet point 4 contains . at the end of the sentence, while the rest of the points does not have it. It would be good if the team could standardise this for better readability.

Screenshot 2024-04-19 at 5.29.49 PM.png

nus-pe-script commented 2 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]

DG is poorly formatted

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.


For DG, it is more severe as there are a lot of formatting errors that are very noticable. Here are all the screenshots that can be considered as quite jarring

Acknowledgements should start at the next page image.png

Very huge gap between the line, and design as well as architecture image.png

Inconsistent padding image.png

The cons are stated in the next page image.png

The implementations are stated in the next page image.png


[original: nus-cs2103-AY2324S2/pe-interim#4107] [original labels: severity.Low type.DocumentationBug]

Their Response to the 'Original' Bug

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

While this is a valid bug, this has been downgraded to severity.VeryLow according to the definition of the label. Screenshot 2024-04-20 at 1.07.20 PM.png

Screenshot 2024-04-20 at 1.05.28 PM.png

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]