From e75a31ebb77ffb31b1a01481d82098f4cec249ff Mon Sep 17 00:00:00 2001 From: Magnus Date: Mon, 5 Dec 2022 19:56:16 +0100 Subject: [PATCH] Update docs and pre-commit formatting --- src/templating.cpp | 3 ++- src/templating.hpp | 3 ++- src_docs/source/index.rst | 2 +- src_docs/source/releases.rst | 30 ++++++++++-------------------- 4 files changed, 15 insertions(+), 23 deletions(-) diff --git a/src/templating.cpp b/src/templating.cpp index b51d570..5a0b65a 100644 --- a/src/templating.cpp +++ b/src/templating.cpp @@ -136,7 +136,8 @@ void TemplatingEngine::initialize(float angle, float gravitySG, } // the useDefaultTemplate param is there to support unit tests. -const char* TemplatingEngine::create(TemplatingEngine::Templates idx, bool useDefaultTemplate) { +const char* TemplatingEngine::create(TemplatingEngine::Templates idx, + bool useDefaultTemplate) { String fname; _baseTemplate.reserve(600); diff --git a/src/templating.hpp b/src/templating.hpp index f843476..f6f0bac 100644 --- a/src/templating.hpp +++ b/src/templating.hpp @@ -200,7 +200,8 @@ class TemplatingEngine { } void initialize(float angle, float gravitySG, float corrGravitySG, float tempC, float runTime); - const char *create(TemplatingEngine::Templates idx, bool useDefaultTemplate = false); + const char *create(TemplatingEngine::Templates idx, + bool useDefaultTemplate = false); }; #endif // SRC_TEMPLATING_HPP_ diff --git a/src_docs/source/index.rst b/src_docs/source/index.rst index e76969a..e2f54d4 100644 --- a/src_docs/source/index.rst +++ b/src_docs/source/index.rst @@ -7,7 +7,7 @@ Welcome to GravityMon ##################### .. note:: - This documentation reflects **v1.2 - beta 2**. Last updated 2022-11-19 + This documentation reflects **v1.2.0**. Last updated 2022-12-05 What is GravityMon? -------------------- diff --git a/src_docs/source/releases.rst b/src_docs/source/releases.rst index 310313f..722cd25 100644 --- a/src_docs/source/releases.rst +++ b/src_docs/source/releases.rst @@ -3,40 +3,30 @@ Releases ######## -v1.2.0 - beta2 -============== +v1.2.0 +====== Features ++++++++ * Added function to calcualate voltage factor based on measured value. * Updated battery estimation for the various esp32 boards. * Added support for the ESP32 lite board which is used in the Floaty Hydrometer variant. - -Documentation -+++++++++++++ -* Added section about the Floaty hardware. - - -v1.2.0 - beta1 -============== - -* Changes to 1.2.0 only affect the ESP32 hardware, the ESP8266 is the same as for v1.1.1 - -Features -++++++++ * Added support for the ESP32 C3 mini board * Added support for the ESP32 S2 mini board * Serial output is written to TX/RX pins instead of the USB connection for the ESP32c3. This way the serial console can be viewed when running on battery power. +* Merged in unit tests and api tests into this project + +Documentation ++++++++++++++ +* Added section about the Floaty hardware +* Fixed schema errors in hardware section and linked PCB options +* Updated hardware section with options for ESP32 boards +* Updated installation instructions. Issues adressed ++++++++++++++++ * BUG: The first portion of a format template was lost when doing conversion. -Documentation -+++++++++++++ -* Updated hardware section with options for ESP32 boards -* Updated installation instructions. - v1.1.1 ====== * BUG: The text before the first variable was missed in the conversion of a format template.