search

luminousleek / pe

0 stars 0 forks source link

Data Field in Glossary missing examples #21

Open luminousleek opened 2 years ago

luminousleek commented 2 years ago

Bug: The entry for "Data Field" in the Glossary does not give examples of what certain data fields are (eg skill, framework), which makes it hard for devs to figure out what exactly they are

Screenshot 2021-11-12 at 5.38.52 PM.png

nus-pe-bot commented 2 years ago

Team's Response

We believe that while the glossary did not specifically mention all the examples, it gave a general understanding of what we refer to as data fields. Moreover, in other mentions of the term data fields, examples were given for other developers to refer to.

Screenshot 2021-11-15 at 12.57.03 PM.png

and

Screenshot 2021-11-15 at 12.58.08 PM.png

As per the CS2103T website, we attempted to minimize unnecessary terms in the glossary while including important terms. We made the design decision of excluding examples and writing them in other areas of the DG when referred to.

Screenshot 2021-11-15 at 12.59.58 PM.png

Items for the Tester to Verify

:question: Issue response

Team chose [response.Rejected]

Reason for disagreement: [replace this with your explanation]

:question: Issue severity

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

Reason for disagreement: [replace this with your explanation]