Skip to content

README: Minor readability improvments #544

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
wants to merge 6 commits into from
Closed

README: Minor readability improvments #544

wants to merge 6 commits into from

Conversation

noahwilliamsson
Copy link

More consistent formatting and a few fixed typos.

@igrr
Copy link
Member

igrr commented Jul 12, 2015

Hi, thanks for the improvements. I'm going to merge everything except "Consistently indicate functions with parentheses" because while some functions really take zero arguments (like millis() and micros()), others need arguments (like pinMode and attachInterrupt), and introducing them without arguments (or some placeholders) is simply not valid. I think the way to go is to make these functions work like hyperlinks pointing to detailed documentation.

@noahwilliamsson
Copy link
Author

Hi, thanks for the feedback.

If you're not merging af1b15b you can also skip the dependent commit 68ba4c3.

I agree it would be better show their arguments and also hyperlink them.

If I was to hyperlink the first mention of each function, would it be OK to link to the Arduino reference and use Arduino's syntax style (i.e. leaving out the parameters' data types) where possible? For instance, like this for the Basic Wiring Functions block:
" pinMode(pin, mode), digitalRead(pin), digitalWrite(pin, mode), analogRead(pin) and analogWrite(pin, value) work as usual."

(For the board specific methods (Serial.swap(), Serial.setDebugOutput(), ESP.restart(), etc) I guess README.md will have to do as the authoritative source as there doesn't seem to be any other place where those methods are documented.)

@igrr
Copy link
Member

igrr commented Jul 14, 2015

Yes, i think keeping the Arduino syntax style and linking to Arduino reference is fine.
I have cherry-picked your commits on to the doc-update branch:
https://github.com/esp8266/Arduino/tree/doc-update
I've started cleaning up and separating the documentation, the goal is to provide "snapshots" for each core version. Right now everyone looks at the most recent version and this leads to some confusion.

@igrr
Copy link
Member

igrr commented Jul 22, 2015

These commits are now part of #587, closing this one.

@igrr igrr closed this Jul 22, 2015
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants