search

lwlshawn / pe

0 stars 0 forks source link

Possibly insufficient documentation for summary command #14

Open lwlshawn opened 3 years ago

lwlshawn commented 3 years ago

image.png

Perhaps more detail can be provided in the documentation, rather then simply stating "statistics", to help the user know what to expect. For example, the fact that the summary shows the total number of elderly is not reflected in the documentation.

nus-pe-bot commented 2 years ago

Team's Response

It does not hinder the reader since the description currently gives a rough idea of what the summary command entails. We decided to omit total number of elderly as we felt this would not be very useful information for the reader, as total number of elderly would not be very useful in most cases anyway. Thanks for the suggestion though!

Items for the Tester to Verify

:question: Issue response

Team chose [response.Rejected]

Reason for disagreement: image.png

As seen here in the textbook, explanations being too brief do qualify for potential UG bugs. In this case, their description entirely omits parts of the functionality of the command (it does not tell the user all the pieces of information that will be given by the summary).

:question: Issue severity

Team chose [severity.VeryLow] Originally [severity.Low]

Reason for disagreement: In this case, this is beyond a typo since it omits explanation of parts of the functionality. Therefore I believe it qualifies for a low, over a "very low" that I believe is mostly reserved for purely cosmetic errors.