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

No example output for many of the functionalities in the UG, code does not look uniform #355

Open
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.



Functionalities with no example output:

image.png

image.png

image.png

image.png

image.png

image.png

image.png

image.png

For the other methods, I believe that example/expected output is clearly given. I can make out that different coders have written the User guide...


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

LowTL commented Apr 21, 2024

Team's Response

I agree that not all commands had an example output, however as per the reference used, expected output is not a necessity.

Duplicate status (if any):

Duplicate of #2559

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