JunHao247 / pe

0 stars 0 forks source link

Invalid URL and hyperlink in Features section of UG #11

Open JunHao247 opened 1 year ago

JunHao247 commented 1 year ago

Screenshot 2023-04-14 at 3.28.14 PM.png

Hyperlink of the [Prefix and parameters] in the below image directs reader to an URL that cannot be found.

Screenshot 2023-04-14 at 3.28.18 PM.png

Screenshot 2023-04-14 at 3.28.36 PM.png

Screenshot 2023-04-14 at 3.28.50 PM.png

nus-pe-bot commented 1 year ago

Team's Response

No details provided by team.

The 'Original' Bug

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

Hyperlink does not work

UG hyper link [Prefix and parameters] does not work, unable to go to prefix section.

Screenshot 2023-04-14 at 2.49.36 PM.png


[original: nus-cs2103-AY2223S2/pe-interim#2148] [original labels: severity.High type.DocumentationBug]

Their Response to the 'Original' Bug

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

Screenshot 2023-04-16 at 11.01.16 AM.png

According to the instructions provided on documentation bugs on the PE website, a broken link should only warrant a Low or Medium severity. There is also no justification by the tester on why it deserves a high severity. Our team accepts the bug, albeit at a low severity, as the Prefixes and Parameter section comes BEFORE the Feature section and readers who have read our UG in order should have already read through the Prefixes and Parameter section. The hyperlink only serves as a convenience tool, should the user forget any important information. Moreover, as the sections are clearly labelled, users can easily scroll to the desired section or even to the TOC, which would redirect them to the desired Prefix and Parameter section.

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.Low`] Originally [`severity.High`] - [ ] I disagree **Reason for disagreement:** [replace this with your explanation]