Documentation Requests/Feedback

bkgoodman
Posts: 45
Joined: Fri Feb 17, 2017 12:41 pm

Re: Documentation Requests/Feedback

Postby bkgoodman » Sat Jan 30, 2021 10:25 pm

Minor thing that would make docs even more helpful: In the documentation, you identify which header files are needed for use. But I find it would be more helpful if you gave an example of HOW they should be included. For example:

Instead of saying:

Code: Select all

heap/include/esp_heap_caps.h
You might say:

Code: Select all

#include <esp_heap_caps.h>
-or-

Code: Select all

#include "heap/include/esp_heap_caps.h"
...or whatever is specifically needed.

OllieK
Posts: 58
Joined: Mon Jan 18, 2016 8:08 am
Location: USA, PA
Contact:

Re: Documentation Requests/Feedback

Postby OllieK » Sun Jan 31, 2021 12:10 am

I like that :D

Who is online

Users browsing this forum: No registered users and 21 guests