nus-cs2113-AY2324S2 / pe-dev-response

0 stars 0 forks source link

Unclear inputs for "rep" in add command #1186

Open nus-pe-bot opened 4 months ago

nus-pe-bot commented 4 months ago

In the add command, you can say how many times to repeat the medication using the 'rep' input. In the UG it is unclear if this means to repeat in a week or something else. ( In this case, I am assuming it means how many times to repeat in a week based on the input being a number from 1-7). However, after you specify the numbers of times to take the medication per week, it does not allow you to say which days you want to take the medication. Thus, when you use the function list to check the medications you have to take for the day, it will give you all the medications in the list . This could be dangerous as perhaps you only have to take the medication on certain days, but could be consuming it wrongly

image.png

image.png

image.png


[original: nus-cs2113-AY2324S2/pe-interim#1413] [original labels: type.FunctionalityBug severity.High]

T0nyLin commented 4 months ago

Team's Response

Thank you for pointing out this bug.

Each medication is added to the today list on the day that it was added into MediTracker, but for the daily list on subsequent days, the list is dictated by the corresponding repeat value.

I agree, the UG can be clearer, so this should at least be a DocumentationBug, to specify that 1 to 7 represents the number of days in a week. As this repeat does not hinder other functionality of the program, I have changed the severity from High to Low.

We can consider a future implementation to allow user to specify the day that they will start taking a medication, as currently, it is assumed that the user starts taking the medication on the day that it was added into MediTracker.

Duplicate status (if any):

--