search

nus-cs2103-AY2223S1 / pe-dev-response

0 stars 0 forks source link

Glossary not enough terms #1080

Open nus-pe-bot opened 2 years ago

nus-pe-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.

Screenshot 2022-11-11 at 5.33.33 PM.png

Glossary too short. Important terms used such as API can perhaps be defined over here. Can cause occasional inconveniences if reader does not understand terms but glossary only has 4 terms.

[original: nus-cs2103-AY2223S1/pe-interim#1402] [original labels: type.DocumentationBug severity.Low]

izzahaj commented 2 years ago

Team's Response

Since this is a developer guide, we expect only developers or people with a sufficient programming knowledge to read it, and hence understand terms such as API.

Duplicate status (if any):

--