Emkay16 / pe

0 stars 0 forks source link

User guide conventions repeated in the middle of the user guide #5

Open Emkay16 opened 3 years ago

Emkay16 commented 3 years ago

Under some features (namely 3.3, 3.3.1, 3.3.2, 3.3.3, 3.3.4 and 3.3.5), the user guide convention ("User inputs are indicated via a preceding > .") that has been stated in section 1.4 is repeated multiple times: image.png

The line is also indicated for an example that showcases no user inputs: image.png

Since this is already mentioned in the user guide convention, perhaps it would be better not to repeat it. The user guide is already very lengthy and repeating this would only serve to add clutter to the user guide.

This is only present in features under section 3.3, perhaps it would be better to standardise the general layout and format of your user guide.

nus-pe-bot commented 3 years ago

Team's Response

This is a valid bug as the user guide should be standardized. However, it does not affect the usage in any way but if anything, serves as extra clarification! Hence, the severity should be very low as the effect of this bug is purely cosmetic.

Items for the Tester to Verify

:question: Issue severity

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

Reason for disagreement: [replace this with your explanation]