Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

[PE-D][Tester A] Description for syntax for command "find" unclear #155

Closed
soc-se-bot opened this issue Mar 31, 2023 · 1 comment · Fixed by #167
Closed

[PE-D][Tester A] Description for syntax for command "find" unclear #155

soc-se-bot opened this issue Mar 31, 2023 · 1 comment · Fixed by #167
Assignees
@cjyothika
Labels
severity.Low A flaw that is unlikely to affect normal operations of the product. type.ErrorMessageBug Error message is not specific/inaccurate type.UGUPdate Need to change UG to reflect application constraints

Comments

@soc-se-bot
Copy link

In the description for command find,

image.png

There is no explanation for the parameters so the user might assume the defination to be the same as the parameters of the same name that appeared in the UG earlier which is:

image.png

However, when I keyed in find /m CS2101S, it gives the error message:

image.png

I guess you want to support find by module prefix only. But it's not stated in the UG.

I guess you can consider redefine that in UG!

Labels: type.DocumentationBug severity.Medium
original: DerrickSaltFish/ped#5
@cjyothika
Copy link

cjyothika commented Apr 1, 2023 •
edited
Loading

Change (/m <code> ) to (/m <code-prefix>) in UG

@cjyothika cjyothika mentioned this issue Apr 1, 2023
Closed
@cjyothika cjyothika self-assigned this Apr 1, 2023
@cjyothika cjyothika mentioned this issue Apr 1, 2023
Merged
@cjyothika cjyothika linked a pull request Apr 1, 2023 that will close this issue
Add notes to clarify some constraints of the app in the UG and fix find command format in UG #167
Merged
@cjyothika cjyothika added severity.Low A flaw that is unlikely to affect normal operations of the product. type.FeatureFlaw Inherent flaw with a feature introduced/pre-existing type.UGUPdate Need to change UG to reflect application constraints type.ErrorMessageBug Error message is not specific/inaccurate and removed type.FeatureFlaw Inherent flaw with a feature introduced/pre-existing labels Apr 1, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@cjyothika cjyothika

Labels
severity.Low A flaw that is unlikely to affect normal operations of the product. type.ErrorMessageBug Error message is not specific/inaccurate type.UGUPdate Need to change UG to reflect application constraints
Projects
None yet
Milestone
No milestone
2 participants
@cjyothika @soc-se-bot