search

nus-cs2103-AY2021S2 / pe-dev-response

0 stars 0 forks source link

Short Descrpition of delete_rec_session is confusing #3124

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.

image.png When the user first read the description, Deleting a recurring tuition session tells the user that this command would most likely to be used to specifically delete only recurring tuition session, however it is actually only used to delete one single session from the recurring session, which can confuse the user

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

chwoozy commented 3 years ago

Team's Response

Hi! Sorry just wanted to check if you have read the description you omitted right under the image. But anyway here it is:

image.png

As stated clearly, this command should delete a single session from an existing tuition session.

Thanks for your feedback :)

ps. It is not gramatically wrong in the orange heading as well; this indeed deletes "a" -> a single, session that is recurring

Duplicate status (if any):

--