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

Insufficient output examples throughout the UG #2559

Open
nus-pe-bot opened this issue Apr 19, 2024 · 1 comment
Open

Insufficient output examples throughout the UG #2559

nus-pe-bot opened this issue Apr 19, 2024 · 1 comment

Comments

@nus-pe-bot
Copy link

nus-pe-bot commented Apr 19, 2024

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.



As a user, I would like to see example outputs of all the possible commands for a better understanding of usage.

However, some commands did not show example output
ie add , promotion commands.


[original: nus-cs2113-AY2324S2/pe-interim#2549] [original labels: severity.Low type.DocumentationBug]
@LowTL
Copy link

LowTL commented Apr 21, 2024

Team's Response

I do agree that we could have furnished the UG with expected outputs, but as per the AB3 reference, expected outputs are not compulsory in the UG.

Duplicate status (if any):

--

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

4 participants