search

avellinwong01 / pe

0 stars 0 forks source link

UG: Better ordering of example usage and expected outputs #18

Open avellinwong01 opened 2 years ago

avellinwong01 commented 2 years ago

image.png

Might be more reader-friendly to put each expected output right after each example usage, so that the reader knows which corresponds to which.

soc-se-bot commented 2 years ago

Team's Response

Duplicate bug already accepted.

The 'Original' Bug

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

UG presentation of input and expected outputs

The formatting is weird as the possible inputs are listed together and the outputs are listed together below. This makes is hard to user to link the inputs to the expected output

image.png

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

Their Response to the 'Original' Bug

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

Thanks for pointing this out! We'll add the changes.

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]

Reason for disagreement: [replace this with your explanation]