nus-pe-bot
commented
2 weeks ago Team's Response
Retrievepa: Intuitively it suggests that a user can get or find a pa after running this command, which in this case the various networks/name/label params aid in doing so. Searchpa: Intuitively suggests that a user can find where a pa is stored, which in this case is the person a unique pa belongs to.
Ultimately, this is issue in a difference of understanding. It is understandable that this may suboptimal naming, and is something we may consider in future versions.
However, since current namings are arguably appropriate for their use cases and both commands are clearly and distinctly documented, we believe this change would bring minimal benefit to users, even possibly leading to someone else having the same issue thinking the original naming is more appropriate. As such, we deem this to be NotInScope given current arrangement does not affect functionality and it is of lower importance as a feature.
References
Items for the Tester to Verify
:question: Issue response
Team chose [response.NotInScope]
- [ ] I disagree
Reason for disagreement: [replace this with your explanation]
The fact that the function that returns a single result is named "searchpa" whereas the function that can return multiple results is named "retrievepa" gives rise to the possibility that the two can be mixed up.
Backing: Retrieve has the connotation of already having the object being sought after performing the action, whereas search does not, and is associated with the term "search results", which can yield multiple responses. Therefore, one would expect the function that obtains the desired target without any further steps should be named as "retrieve", whereas the function which has the additional step of looking through a list of matches to find the desired target should be named as "search".