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

Formatting in UG #16

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

Formatting in UG #16

tangzhenen opened this issue Nov 17, 2023 · 1 comment

Comments

@tangzhenen
Copy link
Owner

tangzhenen commented Nov 17, 2023

Capture.PNG
maybe adding boxes could make it more tidy

@soc-se-bot
Copy link

soc-se-bot commented Nov 20, 2023

Team's Response

User stories are not present in User Guide.

The 'Original' Bug

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

Unclear table formatting for summary of commands 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

It was not very clear which syntax and parameters belonged to which commands. Perhaps it would be better to add table borders?


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

Their Response to the 'Original' Bug

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

Cosmetic issue.

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