search

denzelcjy / pe

0 stars 0 forks source link

Formatting of explanation in the DG #16

Open denzelcjy opened 1 year ago

denzelcjy commented 1 year ago

In this page for StatsCommand, consider placing the Flow of the Stats Command as a header and on a new line, as it was quite difficult to understand what is going on.

Numbering is fine ,If possible, reduce the number of steps since it is very wordy, not to mention there is an already complicated and huge diagram before it.

image.png

soc-pe-bot commented 1 year ago

Team's Response

We accept this but feel that this is a cosmetic issue as stated in https://nus-cs2113-ay2223s2.github.io/website/admin/tp-pe.html and therefore feel that the severity of this bug is very low as it does not really affect much.

The 'Original' Bug

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

DG page breaks not consistent

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.

Just like the UG, the DG also contains many instances of page breaking that can hinder the reader.

These are the screenshots and their relevant pages:

Page 1-2:

image.png

Page 2-3:

image.png

There are many more instances across the entire DG that would be too much to screenshot so I will just leave the 2 examples above as the guidelines.

[original: nus-cs2113-AY2223S2/pe-interim#2112] [original labels: severity.Low type.DocumentationBug]

Their Response to the 'Original' Bug

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

We accept this but feel that this a cosmetic issue (as mentioned in https://nus-cs2113-ay2223s2.github.io/website/admin/tp-pe.html) and therefore feel that the severity of this bug should be VeryLow.

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 severity Team chose [`severity.VeryLow`] Originally [`severity.Low`] - [ ] I disagree **Reason for disagreement:** [replace this with your explanation]