search

rohit0718 / pe

0 stars 0 forks source link

DG Appendix inconsistent formatting #23

Open rohit0718 opened 2 years ago

rohit0718 commented 2 years ago

Inconsistent test case formatting. It seems that a newline is missing just before Expected for "Getting a tutee’s information" instruction.

image.png

Also extra spaces are included in others:

image.png

nus-pe-bot commented 2 years ago

Team's Response

No details provided by team.

The 'Original' Bug

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

Improper indentations for DG

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.

some cases Extensions have inconsistent indents see image for details. UC10 and UC11's extensions

image.png

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

Their Response to the 'Original' Bug

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

As the indentation is merely cosmetic and does not hinder readability, we would accept this as a VeryLow severity.

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: Although I agree with the verylow severity, this is not an appropriate duplicate. The issue that the team marked as duplicate deals with incorrect indents for the use case segment of the Developer Guide while the bug that I reported deals with incorrect newline usage for the "Instructions for manual testing" segment.