vibes-863 / pe

0 stars 0 forks source link

Large gap between content and example usage of delete in UG #16

Open vibes-863 opened 2 months ago

vibes-863 commented 2 months ago

image.png

There is a large gap between the content and the example usage of "delete" under the Usage section in the UG.

The gap causes the usage to be shown on the next page which could result in most users thinking that the it is the end of the UG which is why I have given it a severity of low.

nus-pe-bot commented 2 months ago

Team's Response

It is neater this way with the break-line done this way. On the module website, it is stated that break-lines can be added to increase the readability, and we would like to argue that having it is neater in this format.

Items for the Tester to Verify

:question: Issue response

Team chose [response.NotInScope]

Reason for disagreement: The team has not provided reasons for why it would be NotInScope. In the response, the team states that it is not a bug and that it is done intentionally as "it is neater in this format", however, the team does not reject it.

I would also like to argue that the team claims for it to be "neater" in order to avoid it being categorized as a bug. The reason being, there is enough space after the description of the usage of 'delete' to include the example output in the same page as the size of the example output is small enough. Images of this has been attached.

image.png

The above is one page. The next image is the example output.

image.png


## :question: Issue severity Team chose [`severity.VeryLow`] Originally [`severity.Low`] - [x] I disagree **Reason for disagreement:** The team has not given a reason for why the severity is VeryLow and not Low