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

Help Command code snippet in UG unnecessarily long. #2964

Open
nus-se-bot opened this issue Nov 12, 2021 · 1 comment
Open

Help Command code snippet in UG unnecessarily long. #2964

nus-se-bot opened this issue Nov 12, 2021 · 1 comment
Labels
response.NotInScope severity.Low status.Done team.2 tutorial.CS2113T-F14 type.DocumentationBug

Comments

@nus-se-bot
Copy link

nus-se-bot commented Nov 12, 2021 •
edited by tlyi
Loading

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.


Help Command code snippet in UG is unnecessarily long (about 3 pages). Maybe the team could have included a short sample screenshot or left the snippet out of the DG altogether.

image.png

[original: nus-cs2113-AY2122S1/pe-interim#2960] [original labels: severity.Low type.DocumentationBug]
@tlyi
Copy link
Contributor

tlyi commented Nov 15, 2021

Team's Response

As suggested by our CS2101 tutor, we should include the whole expected output for the command. Due to limitations of PDF, we were unable to put this into a dropdown to make it look shorter.

Duplicate status (if any):

--

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
response.NotInScope severity.Low status.Done team.2 tutorial.CS2113T-F14 type.DocumentationBug
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
2 participants
@nus-se-bot @tlyi