search

nus-cs2113-AY2021S2 / pe-dev-response

0 stars 0 forks source link

Can consider reducing examples for 'add feature' #1181

Open nus-pe-bot opened 3 years ago

nus-pe-bot commented 3 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.

Can consider to remove the first example of input and output since the second example already covers the scope of the first example. Format is quite easy to understand so one example should suffice for the add feature alone. image.png

[original: nus-cs2113-AY2021S2/pe-interim#1181] [original labels: severity.VeryLow type.DocumentationBug]

fupernova commented 3 years ago

Team's Response

The reason behind the second example is to show a sample input that includes prerequisites. This is important as prerequisites are a key part of module planning and we believe there is a need to show users how to enter prerequisites clearly. The prerequisite is also an optional parameter, which the two output clearly shows (i.e. the user can add a module with or without prerequisites).

Duplicate status (if any):

--