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.

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

The parameters for the set command is only specified in the 'Parameter Information' and missing from the 'Setting Difficulty of Flashcards' section. #9

Open
TyrusLye opened this issue Nov 17, 2023 · 1 comment

Comments

@TyrusLye
Copy link
Owner

The parameters for the set command is missing from the 'Setting Difficulty of Flashcards' section.

image.png

And is only specified in the 'Parameter Information' section under the DIFFICULTY parameter, making it hard to find the parameter for the set command :

image.png

@soc-pe-bot
Copy link

[IMPORTANT!: Please do not edit or reply to this comment using the GitHub UI. You can respond to it using CATcher during the next phase of the PE]

Team's Response

No details provided by team.

The 'Original' Bug

[The team marked this bug as a duplicate of the following bug]

Incomplete instruction for "set" feature in UG

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.



Problem:
The choices for DIFFICULTY is not listed.

Screenshot 2023-11-17 at 5.11.55 PM.png

Suggestions:
Perhaps listing out the choices for DIFFICULTY can enhance reader-friendliness.


[original: nus-cs2103-AY2324S1/pe-interim#3065] [original labels: severity.Low type.DocumentationBug]

Their Response to the 'Original' Bug

[This is the team's response to the above 'original' bug]

Thanks for the feedback, we concluded that this bug is rejected, while we agree that it will be easier for readers to refer to if the allowed parameters are added in this section, we have already mentioned in the parameters section as we do not want to over saturate this feature section. A correct list of parameter inputs will also be shown if there is an error in the difficulty field, so we feel that this may not be necessary.

Items for the Tester to Verify

❓ 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 reason]


❓ Issue response

Team chose [response.Rejected]

  • I disagree

Reason for disagreement: [replace this with your reason]


Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

2 participants