search

EdmundTangg / pe

0 stars 0 forks source link

Insufficient details in UG #8

Open EdmundTangg opened 2 months ago

EdmundTangg commented 2 months ago

As a user reading the features in the UG, I am unable to tell what kind of data I should input for each field.

Take the add command for example

image.png

I do not know what kind of data are supposed to be entered for each field

ie BUY_PRICE field. Can it take in just numbers or alphabets are allowed too?

As a user I might want to input buy/twenty dollars.

soc-se-bot commented 2 months ago

Team's Response

I agree that we could have explained it better in the UG. We had given two examples in the format, which should be intuitive that numbers be input into the field. At most, I would argue that we should have been clear that we allow floats up to 2 decimal places.

The 'Original' Bug

[The team marked this bug as a duplicate of the following bug]

No type specification in UG for the different attributes in the add functionality

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.

I think this has been highlighted in the previous bugs too but it is not specific what is the type for these attributes.

image.png From my testing I know that ITEM_NAME can be anything (String, Float, Int). From my testing I figure that item_quantity must be an int. From my testing i figure that buy and sell can be integers or floats (which are then reduced to 2dp).

In the user guide, there's no mention. Moreover, your errors/exceptions do not tell me the exact reason why something's wrong with the inputs.

[original: nus-cs2113-AY2324S2/pe-interim#398] [original labels: severity.Medium type.DocumentationBug]

Their Response to the 'Original' Bug

[This is the team's response to the above 'original' bug]

Accepted as very low as this is replicating real life situation, where quantity can only be a whole number and buy and selling price can take up to 2dp

Items for the Tester to Verify

:question: Issue duplicate status

Team chose to mark this issue as a duplicate of another issue (as explained in the Team's response above)

Reason for disagreement: [replace this with your explanation]

## :question: Issue severity Team chose [`severity.VeryLow`] Originally [`severity.Low`] - [x] I disagree **Reason for disagreement:** Yes it replicating in real life situation. However as a user, I might want to input it as alphabets as stated above `buy/twenty dollars`, which is reasonable as well. Hence , I stand my ground on this bug being [severity.Low]