search

1szheng / pe

0 stars 0 forks source link

UG formatting issue #19

Open 1szheng opened 2 years ago

1szheng commented 2 years ago

The UG's asterisks aren't formatted properly to show what it should actually show.

E.g. bolded 2021-03-18)

image.png

nus-se-script commented 2 years ago

Team's Response

image.png

This is due to PDF conversion issue. We had verified on Markdown to display what was intended. To view our markdown UG: https://raw.githubusercontent.com/AY2122S2-CS2113-F10-2/tp/master/docs/UserGuide.md

The 'Original' Bug

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

Text format in 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.

Regarding DG, is it better to include all class names and methods etc. in " ` "?

E.g. This is done in SearchCommandParser, rather than

image.png

Just like in DG of AddressBook 3:

image.png

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

Their Response to the 'Original' Bug

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

It is already enclosed in backticks.

image.png

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]

Reason for disagreement: Any PDF conversion issues should be vetted by the team and corrected before submission and should not be an excuse. There is no point of having the formatting be correct on the markdown document that most readers would not be reading. Why would readers visit the markdown when a properly formatted website or PDF is available to them? It is also stated that during the PE, we should be referring to the PDF document submitted, so being correct on the markdown page does not contribute in any sense.

When cross referencing with a few other teams, it can be seen that their PDFs do not have a conversion issue. If there was truly no other choices, the developers should have put a remark on their PDF document with a disclaimer of improper formatting due to uncontrollable factors.