nus-pe-bot
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.
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.
Items for the Tester to Verify
:question: Issue response
Team chose [response.Rejected]
- [x] I disagree
Reason for disagreement: The developer guide is used to help developers understand understand how the code works. Hence I would argue that it would be more appropriate to phrase it as a property of type T. This is because the sentence can lead to a confusion between whether property T is referring to a type or a specific initiated object. The string representation of a type can be for instance 'Name' but the string representation of the object would be the the name of the object which is 'Chicken Rice' for instance.
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