From 2c3dbf31067fdf6ad413ba98c4bf449450e4192a Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Vojt=C4=9Bch=20Barto=C5=A1ka?= <76958047+VojtechBartoska@users.noreply.github.com> Date: Thu, 14 Dec 2023 15:18:23 +0800 Subject: [PATCH 1/2] api_compatibility_note --- README.md | 4 ++++ docs/source/libraries.rst | 4 ++++ 2 files changed, 8 insertions(+) diff --git a/README.md b/README.md index 09556346255..476868cb596 100644 --- a/README.md +++ b/README.md @@ -37,6 +37,10 @@ You can use the [Arduino-ESP32 Online Documentation](https://docs.espressif.com/ --- +**APIs compatibility with ESP8266 and Arduino-CORE (Arduino.cc) is available [here](https://docs.espressif.com/projects/arduino-esp32/en/latest/libraries.html#apis).** + +--- + * [Getting Started](https://docs.espressif.com/projects/arduino-esp32/en/latest/getting_started.html) * [Installing (Windows, Linux and macOS)](https://docs.espressif.com/projects/arduino-esp32/en/latest/installing.html) * [Libraries](https://docs.espressif.com/projects/arduino-esp32/en/latest/libraries.html) diff --git a/docs/source/libraries.rst b/docs/source/libraries.rst index 8c5357150a3..f31801ae58d 100644 --- a/docs/source/libraries.rst +++ b/docs/source/libraries.rst @@ -71,6 +71,10 @@ APIs The Arduino ESP32 offers some unique APIs, described in this section: +.. note:: Please be advised that we cannot ensure continuous compatibility between the Arduino Core ESP32 APIs and ESP8266 APIs, as well as Arduino-Core APIs (Arduino.cc). + While our aim is to maintain harmony, the addition of new features may result in occasional divergence. We strive to achieve the best possible integration but acknowledge + that perfect compatibility might not always be feasible. Please refer to the documentation for any specific considerations. + .. toctree:: :maxdepth: 1 :glob: From b64cf6dda61606ebbee7364cc52b7ba56e53ba3a Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Vojt=C4=9Bch=20Barto=C5=A1ka?= <76958047+VojtechBartoska@users.noreply.github.com> Date: Thu, 14 Dec 2023 15:25:15 +0800 Subject: [PATCH 2/2] format_fix --- docs/source/libraries.rst | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/docs/source/libraries.rst b/docs/source/libraries.rst index f31801ae58d..d71caea4099 100644 --- a/docs/source/libraries.rst +++ b/docs/source/libraries.rst @@ -71,7 +71,8 @@ APIs The Arduino ESP32 offers some unique APIs, described in this section: -.. note:: Please be advised that we cannot ensure continuous compatibility between the Arduino Core ESP32 APIs and ESP8266 APIs, as well as Arduino-Core APIs (Arduino.cc). +.. note:: + Please be advised that we cannot ensure continuous compatibility between the Arduino Core ESP32 APIs and ESP8266 APIs, as well as Arduino-Core APIs (Arduino.cc). While our aim is to maintain harmony, the addition of new features may result in occasional divergence. We strive to achieve the best possible integration but acknowledge that perfect compatibility might not always be feasible. Please refer to the documentation for any specific considerations.