chiralcentre / pe

0 stars 0 forks source link

Glossary definitions for certain terms are wrong in the UG #13

Open chiralcentre opened 6 months ago

chiralcentre commented 6 months ago

CSV refers to comma separated value, while JSON refers to JavaScript object notation. The definitions of these two terms are wrong. To make it such that the current phrasing in the UG will work, it might be better to change the terms to CSV file and JSON file respectively.

image.png

soc-pe-bot commented 6 months ago

Team's Response

With reference to the CS2103/T Website: Minor typos: These are still considered as severity.VeryLow type.DocumentationBug bugs (even if it is in the actual UI) which carry a very tiny penalty.

We did not include the full name as day to day users need not know what the full names of the file are, rather they just need to know what these files do and what they end with in the file names

Items for the Tester to Verify

:question: Issue severity

Team chose [severity.VeryLow] Originally [severity.Low]

Reason for disagreement: I disagree that this is merely a typo error, as even if I change the terms to CSV file and JSON file, the definitions themselves are wrong and can be improved on. To be precise, CSV files store tabular data separated by commas, and they do not necessarily need to be in spreadsheet form. The team's definition for a JSON file is very vague and generic; every file type stores data, not just JSON files. The unique point about JSON files is that it stores data in the form of key-value pairs. I understand that full names may not be required, but some insights into their structure will be helpful in the glossary (apart from the file extension).