Skip to content

The documentation for analogReference is misleading #2391

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
nickgammon opened this issue Oct 26, 2014 · 2 comments
Closed

The documentation for analogReference is misleading #2391

nickgammon opened this issue Oct 26, 2014 · 2 comments
Labels
Component: Documentation Related to Arduino's documentation content feature request A request to make an enhancement (not a bug fix)

Comments

@nickgammon
Copy link

The page for analogReference ( http://arduino.cc/en/Reference/AnalogReference ) has the word (type) in the heading, like this:

analogReference(type)

That implies that analogReference is a type, rather than a function. Also there is no example of calling it, adding to the confusion.

I suggest removing "(type)" from the heading, and adding an example, eg.

analogReference (INTERNAL);   // use the internal reference voltage
analogReference (DEFAULT);    // use the default reference voltage
@matthijskooijman
Copy link
Collaborator

I suspect that the (type) is intended to mean that the function takes a single argument, called "type". However, that notation is inconsistent with other functions, which have just the function name in the heading and have a "syntax" section that shows the arguments to the function. Making this consistent sounds like a good plan.

@matthijskooijman matthijskooijman added feature request A request to make an enhancement (not a bug fix) Component: Documentation Related to Arduino's documentation content labels Oct 26, 2014
@agdl
Copy link
Member

agdl commented Nov 6, 2014

@nickgammon & @matthijskooijman corrected many thanks

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Component: Documentation Related to Arduino's documentation content feature request A request to make an enhancement (not a bug fix)
Projects
None yet
Development

No branches or pull requests

3 participants