Update documentation based on review

Author: sebromero

README.md

@@ -43,7 +43,7 @@ In addition to the three Deep Sleep Locks already mentioned, additional locks ma
 
 ### 😴 Standby Mode
 
-In Standby Mode, both the sketch and Mbed are entirely stopped by the library, and it asks the microcontroller to turn off almost all functionality to save power. You can wake it up from this mode in two ways: pulling the GPIO 0 pin low on the Portenta Breakout Board (no external pull-up resistor is necessary) or asking the library to wake up after a certain amount of time. The delay can be set anywhere from 1 second up to 36 hours, 24 minutes, and 32 seconds. When the board wakes up again, it's more or less in the same state as it would have been if you had pressed the reset button. You can ask the library what the board was doing before it woke up by calling `wasInCPUMode()`. More information on this can be found [here](./docs).
+In Standby Mode, both the sketch and Mbed are entirely stopped by the library, and it asks the microcontroller to turn off almost all functionality to save power. You can wake it up from this mode in two ways: pulling the GPIO 0 pin low on the Portenta Breakout Board (no external pull-up resistor is necessary) or asking the library to wake up after a certain amount of time. The delay can be set anywhere from 1 second up to 36 hours, 24 minutes, and 32 seconds. When the board wakes up again, it's more or less in the same state as it would have been if you had pressed the reset button. You can ask the library what the board was doing before it started by calling `wasInCPUMode()`. More information on this can be found [here](./docs).
 
 ## ⚖️ License
 

docs/README.md

@@ -18,8 +18,8 @@ The only function necessary to enable automatic Deep Sleep Mode is `allowDeepSle
 ### Standby Mode
 
 To use Standby Mode, you need the following functions: `checkOptionBytes()`, `prepareOptionBytes()`, `standbyM7()`, and `standbyM4()`. The option byte functions are necessary to ensure that the flash option bytes in the microcontroller are correctly set for going into Standby Mode. 
-Additionally, you can use `wasInCPUMode()` to check what the board was doing before it woke up:
-By passing one of the modes `d1Standby`, `d2Standby`, `standby` or `stop` as parameter you can determine in which of these modes the CPU was while it was in standby. It's possible that the CPU was in more than one of these modes so you need to check for each mode separately to get the complete picture.
+Additionally, you can use `wasInCPUMode()` to check what the board was doing before it started:
+By passing one of the modes `d1Standby`, `d2Standby`, `standby` or `stop` as parameter you can determine in which of these modes the CPU was before it started. It's possible that the CPU was in more than one of these modes so you need to check for each mode separately to get the complete picture.
 Only if `wasInCPUMode(CPUMode::standby)` returns true, Standby Mode was entered correctly. The other functions can be handy for troubleshooting. Remember to clear the mode flags by calling `resetPreviousCPUModeFlags()` when you are done checking them.
 
 The microcontroller has three power domains: one for the M7 core (D1), one for the M4 core (D2), and a separate third domain (D3) for some other functionality. `wasInCPUMode(CPUMode::d1Standby)` returns true if D1 was in standby, but all three weren't at the same time, while `wasInCPUMode(CPUMode::d2Standby)()` returns true if D2 was in standby, but all three weren't at the same time. Both functions can return true simultaneously if D1 and D2 were in standby mode while D3 was still awake. When all three domains are in standby mode simultaneously, the microcontroller as a whole enters Standby Mode automatically, and `wasInCPUMode(CPUMode::standby)` returns true when it wakes up again. The `wasInCPUMode(CPUMode::stop)` function should never return true but can be helpful for further troubleshooting if you encounter any issues with this library.

examples/Standby/Standby.ino

@@ -7,7 +7,7 @@
 * The microcontroller has three power domains: one for the M7 core (D1), 
 * one for the M4 core (D2), and a separate third domain (D3) for some other functionality.
 * When all three domains are in standby mode simultaneously, the microcontroller as a whole 
-* enters Standby Mode automatically, and `modeWasStandby()` only returns true when it wakes up again.
+* enters Standby Mode automatically, and `wasInCPUMode(CPUMode::standby)` returns true when it wakes up again.
 *
 * IMPORTANT: Upload the same sketch to both the M7 and the M4 core.
 *

src/Arduino_LowPowerPortentaH7.h

@@ -67,8 +67,8 @@ enum class LowPowerReturnCode
 */
 enum class CPUMode
 {
-    d1Standby,                  ///< Standby mode for the M7 core
-    d2Standby,                  ///< Standby mode for the M4 core
+    d1Standby,                  ///< Standby mode for the D1 domain
+    d2Standby,                  ///< Standby mode for the D2 domain
     standby,                    ///< Standby mode for the whole microcontroller
     stop                        ///< Stop mode for the whole microcontroller
 };
@@ -287,19 +287,19 @@ class LowPowerPortentaH7 {
         LowPowerReturnCode checkOptionBytes() const;
 
         /**
-         * Checks if the microcontroller was in the given standby mode before waking up.
+         * Checks if the microcontroller was in the given CPU mode before starting.
          * Note: It's possible that the microcontroller was in more than one of these modes
-         * during standby. Call this function multiple times to check for each mode.
+         * before starting. Call this function multiple times to check for each mode.
          * Important: When you're done checking, call resetStandbyModeFlags() to reset the flags
-         * so they are reported correctly the next time the microcontroller wakes up.
+         * so they are reported correctly the next time the microcontroller starts.
          * @param mode The CPU mode to check.
          * @return True if the microcontroller was in the given mode, false otherwise.
          */
         bool wasInCPUMode(CPUMode mode) const;
 
         /**
         * @brief Reset the flags that are used to determine the microcontroller's
-        * previous standby mode. This is necessary to get correct results from
+        * previous CPU mode. This is necessary to get correct results from
         * wasInCPUMode().
         */
         void resetPreviousCPUModeFlags() const;