nus-cs2113-AY1920S2 / pe-dev-response

0 stars 0 forks source link

Lacking explanation for deleting ingredients #667

Open nus-pe-bot opened 4 years ago

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


No details provided. 39f9f580d1ad91a3de5ae6337d901f9.png Expenditure bit should be also explained before showing outcomes.


[original: nus-cs2113-AY1920S2/pe-interim#669]

cheongisabella commented 4 years ago

Team's Response

The Expenditure feature is a supplementary and complicated feature being integrated into the deleteingredient feature. However, since we limit the explanation of each feature to be only about that particular feature, the main feature to focus on here is the deleteingredient feature and how its function is to delete ingredients from inventory. Inserting explanations on Expenditure might overcomplicate the usage of deleteingredient and take away the focus on the deleteingredient function. It will also make things less concise for readers. Users are also provided sufficient information on the usage of this Expenditure bit in the deleteingredient feature, since responding to the prompts is very intuitive and the prompts are self-explanatory. Different outcomes of the prompts are also provided in the 3 different examples, which clearly shows what the user might expect. Further information is also provided in the Expenditure section of the User Guide, which focuses on issues relating to Expenditure. Appropriate references to the Expenditure and deleteingredient sections are provided.

Explanation of Expenditure bit in Delete ingredient.png

Duplicate status (if any):

--