shuyangk / pe

0 stars 0 forks source link

Formatting issues when showing code excerpts #14

Open shuyangk opened 11 months ago

shuyangk commented 11 months ago

There is a formatting issue where the is still shown in the final pdf for the below lines, while for the rest of the DG it's shown as code excerpts image.png

image.png

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

Slight formatting issue in the 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.


image.png

The quotation marks does not seem to be working as intended.


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

Their Response to the 'Original' Bug

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

This does not hinder the reader, and the meaning of the text remains well-intact. Thus, as per course website, due to the lack of hindrance, it is not considered a bug.

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 response Team chose [`response.Rejected`] - [x] I disagree **Reason for disagreement:** The meaning of the text is definitely changed, because the text can be intepreted as containing the ` notations. Given that other parts of the DG do not have the ` notation, this shows inconsistency in documentation.