nus-pe-script
commented
2 years ago Team's Response
The purpose of the find command is to verify that some instrument the user wants to record has already been recorded in the watchlist. Therefore, given this purpose of the find command, having it display the true indexes in not necessary.
But the tester's concern is valid and is a duplicate of the issue pertaining to what is the purpose/philosophy of the find command itself. Therefore by resolving #2888, it requires the program implementation to match it as well which solves this issue.
Downgrading the severity to Medium since the bug only causes occasional inconvenience if there are many instruments in the watchlist which make the find command just for verification redundant, but makes the find command with true index more beneficial.
The 'Original' Bug
[The team marked this bug as a duplicate of the following bug]
Purpose of finding an instrument unclear
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.
The user story for finding an instrument does not have a clear purpose. It does not locate the instrument as stated, since all it does is verify if the instrument exists in the list. It does not enable the user to do anything more with the located instrument with any other command, as the listed instruments with the 'find' command start from index '1'.
[original: nus-cs2113-AY2122S1/pe-interim#2835] [original labels: severity.High type.DocumentationBug]
Their Response to the 'Original' Bug
[This is the team's response to the above 'original' bug]
The reason for the existence of the find command is to enable users to verify that they have indeed added an instrument into the watchlist as they had expected.
Therefore, the find command's purpose is for verification rather than locating and then continuing on with some other action.
We agree that this purpose should have been mentioned clearly in the UG to prevent confusion. Nevertheless, the user's suggestion to have the true index of the instruments found is a good one too. With the current purpose of the find command, this suggestion to display the true index of the instrument is out-of-scope, but we can take this into account in the future.
But still, indicating the purpose of the find command in the documentation is necessary.
However, we have downgraded the severity to Medium since the bug only causes occasional inconvenience if there are many instruments in the watchlist which make the find command just for verification redundant, but makes the find command with true index more beneficial.
Items for the Tester to Verify
:question: Issue duplicate status
Team chose to mark this issue as a duplicate of another issue (as explained in the Team's response above)
- [ ] I disagree
Reason for disagreement: [replace this with your explanation]
:question: Issue type
Team chose [type.DocumentationBug]
Originally [type.FeatureFlaw]
- [ ] I disagree
Reason for disagreement: [replace this with your explanation]
:question: Issue severity
Team chose [severity.Medium]
Originally [severity.High]
- [ ] I disagree
Reason for disagreement: [replace this with your explanation]
When searching for an instrument, I want to be able to find, then edit/delete/mark the instrument as done. The indexes shown in the 'find' command do not enable me to do so as they do not reflect the real indexes used in the 'edit'/'delete'/'done' commands.