Skip to content
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

Documenting a few Esp.cpp methods #3057

Merged
merged 3 commits into from
May 14, 2017
Merged

Documenting a few Esp.cpp methods #3057

merged 3 commits into from
May 14, 2017

Conversation

tabarra
Copy link
Contributor

@tabarra tabarra commented Mar 18, 2017

Adding: getCoreVersion, getSdkVersion, getCpuFreqMHz, getSketchSize, getFreeSketchSpace and getSketchMD5.

Adding: getCoreVersion, getSdkVersion, getCpuFreqMHz, getSketchSize, getFreeSketchSpace and getSketchMD5.
doc/libraries.md Outdated

`ESP.getSketchSize()` returns the size of the current sketch as an unsigned 32-bit integer.

`ESP.getFreeSketchSpace()` returns the free sketch space as an unsigned 8-bit intege.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Typo, "intege". Also the function returns an uint32_t, not an uint8_t.

@codecov-io
Copy link

Codecov Report

Merging #3057 into master will increase coverage by 0.24%.
The diff coverage is n/a.

Impacted file tree graph

@@            Coverage Diff             @@
##           master    #3057      +/-   ##
==========================================
+ Coverage   27.57%   27.82%   +0.24%     
==========================================
  Files          20       20              
  Lines        3655     3626      -29     
  Branches      678      656      -22     
==========================================
+ Hits         1008     1009       +1     
+ Misses       2469     2441      -28     
+ Partials      178      176       -2
Impacted Files Coverage Δ
cores/esp8266/Stream.cpp 17.18% <0%> (-0.24%) ⬇️
cores/esp8266/core_esp8266_noniso.c 0% <0%> (ø) ⬆️
cores/esp8266/spiffs/spiffs_check.c 0% <0%> (ø) ⬆️
cores/esp8266/MD5Builder.cpp 80.76% <0%> (ø) ⬆️
cores/esp8266/Print.cpp 5.06% <0%> (+0.03%) ⬆️
cores/esp8266/WString.cpp 15.16% <0%> (+0.03%) ⬆️
cores/esp8266/spiffs/spiffs_gc.c 2.62% <0%> (+0.04%) ⬆️
cores/esp8266/spiffs/spiffs_hydrogen.c 38.34% <0%> (+0.27%) ⬆️
cores/esp8266/spiffs/spiffs_nucleus.c 42.08% <0%> (+0.3%) ⬆️
cores/esp8266/spiffs_api.h 44.7% <0%> (+0.32%) ⬆️
... and 1 more

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 0b47911...e719ed1. Read the comment docs.

@tabarra
Copy link
Contributor Author

tabarra commented May 14, 2017

Done. Not sure if I need to rebase tho.

@igrr igrr merged commit 9fd270f into esp8266:master May 14, 2017
@tabarra tabarra deleted the patch-1 branch May 14, 2017 13:39
igrr added a commit that referenced this pull request May 14, 2017
- 9fd270f Documenting a few Esp.cpp methods (#3057)
- 2881e91 Fix typo in client-class.md (#3045)
- 97373e7 Add instructions how to re-enable DHCP (#2600)
- af0f5ed Issue #1062: Implement support for HSPI overlap mode.
- ca3a172 Addition of gen4-IoD Range boards (#3202)
- d2b370b add AsyncPing library to libraries.md (#2889)
- adeed6b Updated arduino-esp8266fs-plugin link to 0.3.0 (#2846)
- b701b98 Update libraries.md (#2808)
- 898d280 Update readme.md (#2809)
- remove newlines from ota_updates/readme.rst
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.

3 participants