Yttruire / pe

0 stars 0 forks source link

A link to link appears confusing #10

Open Yttruire opened 2 years ago

Yttruire commented 2 years ago

Just like in the title, due to the nature of the Link feature, it may be confusing to the reader when referring to the Link feature, when not specifying that we are referring to the feature.

image.png

In this instance, it is a hyperlink to a section about the Link feature, but it is simply labelled as "link", which appears confusing until we click on the link and realise that it refers to the feature. The "link" should thus at least be capitalised, or referred to as the "link feature" or "link command" rather than just "link"

In the following positive example, it is very clear that it is referring to a feature.

image.png

nus-pe-bot commented 2 years ago

Team's Response

Result

Rejected.

Rationale:

It is clear in this instance that the word link is referring to a hyperlink, but rather referring to our link feature, due to the use of the words ‘implementation for’ preceding the word link. Furthermore, we see no need for capitalisation of the word link due to the already clear nature of the sentence.

Items for the Tester to Verify

:question: Issue response

Team chose [response.Rejected]

Reason for disagreement: [replace this with your explanation]