Deunitato / pe

0 stars 0 forks source link

Inconsistency in code #13

Open Deunitato opened 4 years ago

Deunitato commented 4 years ago

No details provided. image.png

Sometimes its ingredients sometimes its Ingedient, sometimes its ingredient and sometimes is Ingredients

So what is it?

nus-pe-bot commented 4 years ago

Team's Response

Ingredient was used to refer to the class Ingredient when it is important for the reader to know that we were referring to the class Ingredient. We use 'Ingredients', 'ingredients' and 'ingredient' when we are simply talking about an ingredient or several ingredients in prose, simply to be grammatically correct and to improve readability. For these instances, the user either do not necessarily need to refer to the class Ingredient or it was already obvious to the user that we are referring to the class Ingredient. Hence we used the words 'ingredient', 'ingredients' and 'Ingredients' to improve readability. In fact, these words were actually not enclosed by backticks so the user knows that we are using these words in prose and there isn't another class called Ingredients, etc.

This is similar to how AB3 refers to AddressBook in prose as simply address book.

image.png

Items for the Tester to Verify

:question: Issue response

Team chose [response.Rejected]

Reason for disagreement: As in in code blocks, AB3 is consistent. They do not AddressBook and addressBook. Especially since your's is a command, your user guide/ developer guide is inconsistent in the use of this command.

Sometimes your command is add Ingredient sometimes it is add ingredient

This is not consistent!


:question: Issue severity

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

Reason for disagreement: [replace this with your explanation]