Skip to content

Possible inconsistency in reference example re: external links #535

Open
@per1234

Description

@per1234

In the "See also" section, the reference sample has this to say about external links:

// Please note that all external links need to be opened in a new window/tab by adding ^ right before the last square brackets
* #DEFINITION# http://arduino.cc/en/Tutorial/PWM[PWM^]

However, in the Description, there is an external link which does not use the syntax to open in a new window/tab:

Writes an analog value (http://arduino.cc/en/Tutorial/PWM[PWM wave]) to a pin. Can be used to light a LED at varying brightnesses or drive a motor at various speeds. After a call to `analogWrite()`, the pin will generate a steady square wave of the specified duty cycle until the next call to `analogWrite()` (or a call to `digitalRead()` or `digitalWrite()` on the same pin). The frequency of the PWM signal on most pins is approximately 490 Hz. On the Uno and similar boards, pins 5 and 6 have a frequency of approximately 980 Hz.

Although I don't have strong feelings either way about opening links in new windows/tabs, it seems a bit inconsistent to handle external links one way in a specific section, and a different way in the rest of the document. Is this intentional policy, or simply an oversight?

If the latter, I'm happy to submit a PR to correct the reference sample as well as the significant number of reference pages which don't open non-"See also" external links in a new window/tab.

Metadata

Metadata

Assignees

No one assigned

    Labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions