eliztan / pe

0 stars 0 forks source link

UG Typo: wrong words are in code snippet, correct words are not #9

Open eliztan opened 2 months ago

eliztan commented 2 months ago

image.png

On page 10 of the UG, all words that likely should not be in a code snippet after For Example are, and those that likely should be are not due to the double `` at the beginning of the sentence.

soc-pe-bot commented 2 months ago

Team's Response

Accepted.

The 'Original' Bug

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

UG Typo: Incorrect code snippets

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.


Page 12:

image.png

image.png

image.png

Page 13:

image.png

On Page 12 and Page 13 of the UG, there are multiple commands that should likely be in code snippets but are not due to incorrect characters.


[original: nus-cs2113-AY2324S2/pe-interim#2005] [original labels: type.DocumentationBug severity.VeryLow]

Their Response to the 'Original' Bug

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

Accepted.

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]