Skip to content

Commit

Permalink
Update docstubs stubs for preview
Browse files Browse the repository at this point in the history
  • Loading branch information
Josverl committed Jul 23, 2024
1 parent b5436a8 commit 97ccca8
Show file tree
Hide file tree
Showing 2 changed files with 12 additions and 6 deletions.
16 changes: 11 additions & 5 deletions stubs/micropython-v1_24_0_preview-docstubs/machine.pyi
Original file line number Diff line number Diff line change
Expand Up @@ -1626,16 +1626,22 @@ def freq(hz: Optional[Any] = None) -> Incomplete:

def idle() -> Incomplete:
"""
Gates the clock to the CPU, useful to reduce power consumption at any time during
short or long periods. Peripherals continue working and execution resumes as soon
as any interrupt is triggered (on many ports this includes system timer
interrupt occurring at regular intervals on the order of millisecond).
Gates the clock to the CPU, useful to reduce power consumption at any time
during short or long periods. Peripherals continue working and execution
resumes as soon as any interrupt is triggered, or at most one millisecond
after the CPU was paused.
It is recommended to call this function inside any tight loop that is
continuously checking for an external change (i.e. polling). This will reduce
power consumption without significantly impacting performance. To reduce
power consumption further then see the :func:`lightsleep`,
:func:`time.sleep()` and :func:`time.sleep_ms()` functions.
"""
...

def sleep() -> Incomplete:
"""
``Note:`` This function is deprecated, use `lightsleep()` instead with no arguments.
``Note:`` This function is deprecated, use :func:`lightsleep()` instead with no arguments.
"""
...

Expand Down
2 changes: 1 addition & 1 deletion stubs/micropython-v1_24_0_preview-docstubs/modules.json
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@
"firmware": "micropython-v1_24_0_preview",
"nodename": "micropython",
"version": "v1.24.0-preview",
"release": "v1.24.0-preview-121-g444d7bacb",
"release": "v1.24.0-preview-132-gba9853345",
"sysname": "micropython"
},
"stubber": {
Expand Down

0 comments on commit 97ccca8

Please sign in to comment.