search

nus-cs2113-AY2122S1 / pe-dev-response

0 stars 0 forks source link

Formatting in UG #1576

Open nus-se-bot opened 2 years ago

nus-se-bot commented 2 years ago

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.

Weird formatting especially with "e.g when prompted.." Could be rephrased. Could consider putting in an example output here because this is right at the start of the program and users have no idea what u are referring to

Screenshot 2021-11-12 at 5.20.06 PM.png

[original: nus-cs2113-AY2122S1/pe-interim#1629] [original labels: severity.Medium type.DocumentationBug]

EdwardZYWang commented 2 years ago

Team's Response

We did not want to use markdown as the example input is a small one, and we did not want the formatting to be even weirder with a random markdown box before we even reach the other commands.

Duplicate status (if any):

--