search

nus-cs2103-AY2223S2 / pe-dev-response

1 stars 0 forks source link

property T can be vague in the context #1235

Open nus-pe-bot opened 1 year ago

nus-pe-bot commented 1 year 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.

It would be better to write property T as type T, since in the context of java generics T is a type. Additionally, putting T within a code block would also make the sentence more understandable Screenshot (99).png

[original: nus-cs2103-AY2223S2/pe-interim#1586] [original labels: severity.VeryLow type.DocumentationBug]

filbertphang commented 1 year ago

Team's Response

the DG has clearly stated its target audience to be software developers who intend to work on RIZZipe, and recommends readers to have some technical knowledge of Java.

image.png

in addition, the previous line already uses T in PropertyNameContainsKeywordPredicate<T>, so it should be clear to the reader that T is a type parameter for the predicate.

furthermore, we refer to T as a "property" rather than a "type" as these predicates are specific to the find-by-property feature, and we are indeed using such a predicate to filter for a given property of a recipe, rather than any arbitrary type of object.

although we agree that putting T in a code block would improve readability, we reject this bug report on the above grounds.

Duplicate status (if any):

--