Skip to content

Commit 3982175

Browse files
committed
doc: update docstring in sleep function for clarity and consistency; add replacement for 'Allows' in API generator
1 parent ba2d715 commit 3982175

File tree

2 files changed

+3
-2
lines changed

2 files changed

+3
-2
lines changed

notecard/card.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -621,7 +621,7 @@ def restart(card):
621621

622622
@validate_card_object
623623
def sleep(card, mode=None, off=None, on=None, seconds=None):
624-
"""Allows the ESP32-based Notecard WiFi v2 to fall back to a low current draw when idle (this behavior differs from the STM32-based Notecards that have a `STOP` mode where UART and I2C may still operate). Note that the Notecard WiFi v2 will not enable a "sleep" mode while plugged in via USB. Read more in the guide on using Deep Sleep Mode on Notecard WiFi v2.
624+
"""Allow the ESP32-based Notecard WiFi v2 to fall back to a low current draw when idle (this behavior differs from the STM32-based Notecards that have a `STOP` mode where UART and I2C may still operate). Note that this power state is not available if the Notecard is plugged in via USB. Read more in the guide on using Deep Sleep Mode on Notecard WiFi v2.
625625
626626
Args:
627627
card (Notecard): The current Notecard object.

scripts/generate_apis.py

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -164,7 +164,8 @@ def convert_to_imperative_mood(self, text: str) -> str:
164164
"Specifies": "Specify",
165165
"Determines": "Determine",
166166
"The": "Use",
167-
"This": "Use"
167+
"This": "Use",
168+
"Allows": "Allow"
168169
}
169170

170171
# Apply replacements - only replace at the start of sentences

0 commit comments

Comments
 (0)