search

nus-cs2103-AY2122S2 / pe-dev-response

0 stars 0 forks source link

Unexplained link between addRole list and deleteCompany #2494

Open nus-pe-bot opened 2 years ago

nus-pe-bot commented 2 years ago

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

Under the examples of uses of addRole there is an addition of the list function that relates to deleting a company. This may be a typo or an unintended example but it does add confusion to the reader who cannot be sure what exactly this example is meant to show.

[original: nus-cs2103-AY2122S2/pe-interim#2479] [original labels: severity.Low type.DocumentationBug]

justinyjt commented 2 years ago

Team's Response

As mentioned by the reporter, this was a typographical error and should be classified as a very low bug as it does not inconvenience the reader and does not provide erroneous information.

Duplicate status (if any):

--