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

Under 7.2.1 of UG, example input is cut short #2

Open
lkwlkww opened this issue Nov 11, 2022 · 1 comment
Open

Under 7.2.1 of UG, example input is cut short #2

lkwlkww opened this issue Nov 11, 2022 · 1 comment

Comments

@lkwlkww
Copy link
Owner

lkwlkww commented Nov 11, 2022

The example command is cut short (does not show full address, as well as the tag parameter).
A user who has read through the UG should be able to infer the rest of the example (as well as come up with a basic add command example). He might also be able to infer it from the result screenshot below the example screenshot. But for someone who just wants to immediately try adding a contact, it might be a bit confusing.

A snippet of the example screenshot, and the result screenshot:

Screenshot 2022-11-11 at 4.19.15 PM.png

@nus-pe-script
Copy link

nus-pe-script commented Nov 14, 2022

Team's Response

Thank you for your input. However we think that the severity should be very low, because it is a layout (cosmetic) issue. Furthermore, you are also able to see the correct uncropped part in the result picture.

This is a duplicate issue because it concerns the same thing about unable to scroll causing it to be cropped.

The 'Original' Bug

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

Unable to scroll despite the existance of scrollbar 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.



image.png

Refer to this section of the DG, specifically example input. Try scrolling the scroll bar to get the example input.


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

Their Response to the 'Original' Bug

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

Thank you for your input. Yes, this is a cosmetic mistake in our end. Copy pasting the cropped example input still produces a valid command. Additionally, there are more example inputs provided in the UG command summary and in the error messages in the app. Hence, users will not lack examples for using this command.

image.png

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 explanation]


❓ Issue severity

Team chose [severity.VeryLow]
Originally [severity.Low]

  • I disagree

Reason for disagreement: [replace this with your explanation]


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