search

nus-cs2113-AY2021S2 / pe-dev-response

0 stars 0 forks source link

Could use more markups #1336

Open nus-pe-bot opened 3 years ago

nus-pe-bot commented 3 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.

Minor issue, but having markups on some of the words would make differentiating between a word and a function in the application easier. An example is given below. As shown, I was confused if the shortlist is a description of a special type of list (which I would check the glossary for) or a function or variable name. Sometimes, the text could be so confusing it makes the DG difficult to understand.

image.png

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

jadenwjh commented 3 years ago

Team's Response

Are you specifically describing the issue with ShortList only? Can you give other examples where is was confusing for you?

Duplicate status (if any):

--