search

nus-cs2113-AY2021S2 / pe-dev-response

0 stars 0 forks source link

Data is stored as a .json file, not a text file #377

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.

image.png

Based on the TP constraints, the data is to be stored in a human editable text file. However, the program stores it in a .json file. I do agree though, that parsing of a JSON file would be more reliable.

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

xseh commented 3 years ago

Team's Response

JSON is the commonly used standard for both parsing and understanding by humans. As compared to usage of delimiters, the better structure makes each parameter much easier to understand. (e.g. compare [add, 1, A, C, cs1010, modulename] with { name: modulename, grade: A, type: C, code: cs1010 }). The use of JSON in fact, makes understanding and editing the storage file easier with the clearly marked parameters names.

Duplicate status (if any):

--