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

Missing information. #2967

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

Missing information. #2967

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

Comments

@nus-se-bot
Copy link

nus-se-bot commented Nov 12, 2021

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

In the above diagram, in the following part

image.png

It would be hard for the reader to know what parameters does returns parameter refer to.


[original: nus-cs2113-AY2122S1/pe-interim#2964] [original labels: severity.Medium type.DocumentationBug]
@theodorekwok
Copy link
Contributor

theodorekwok commented Nov 13, 2021

Team's Response

From the yellow note, it states clearly that user input details are stored as parameters. So an explanation for what parameters refer is already given.

Downgrading this severity to low as the reader has reference to the note to know that the parameters refer to the attributes of the instrument thus this would barely inconvenience the reader.

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

3 participants