jmestxr / pe

0 stars 0 forks source link

Minor "newline" formatting issues in DG Use Cases #16

Open jmestxr opened 1 year ago

jmestxr commented 1 year ago

In the DG use cases section, newlines could have been added to segregate one point from the next. For example:

Screenshot 2023-04-14 at 3.25.16 PM.png

Moreover, the sentence "Use case ends" could be written to the next line:

Screenshot 2023-04-14 at 3.23.14 PM.png

nus-se-bot commented 1 year 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: Formatting within Use cases

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.


There are multiple instances of formatting issues within the 'Use cases' section in the DG, specifically with missing line breaks (and run-on lines as a result). An example is in the screenshot below (MSS step 2: "Ultron adds the opening to its list of openings Use case ends." - Use case ends should have been on a separate line; Extensions 1a1 should have been on a separate line, etc):

image.png


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

Their Response to the 'Original' Bug

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

Good catch. We admit defeat.

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]