Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

docs: Update docs for firmware v4.5.8 and v4.5.9. #128

Merged
merged 2 commits into from
Sep 5, 2024
Merged

docs: Update docs for firmware v4.5.8 and v4.5.9. #128

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
117b3c5
docs: Update docs for firmware v4.5.8.
kwagyeman Jul 31, 2024
ab84769
docs/library: Update docs for openmv 4.5.9 release.
kwagyeman Sep 5, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion docs/genrst/builtin_types.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

Builtin types
=============
Generated Tue 23 Jul 2024 04:46:38 UTC
Generated Wed 31 Jul 2024 20:47:23 UTC

Exception
---------
Expand Down
4 changes: 2 additions & 2 deletions docs/genrst/core_language.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

Core language
=============
Generated Tue 23 Jul 2024 04:46:38 UTC
Generated Wed 31 Jul 2024 20:47:23 UTC

.. _cpydiff_core_fstring_concat:

Expand Down Expand Up @@ -454,7 +454,7 @@ Sample code::
+----------------+------------------------------------------------------------------------------------------------+
| :: | :: |
| | |
| {'val': 2} | {'test': <function test at 0x7f0666666260>, '__name__': '__main__', '__file__': '<stdin>'} |
| {'val': 2} | {'test': <function test at 0x7fadd0382260>, '__name__': '__main__', '__file__': '<stdin>'} |
+----------------+------------------------------------------------------------------------------------------------+

.. _cpydiff_core_locals_eval:
Expand Down
22 changes: 11 additions & 11 deletions docs/genrst/modules.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

Modules
=======
Generated Tue 23 Jul 2024 04:46:38 UTC
Generated Wed 31 Jul 2024 20:47:23 UTC

.. Preamble section inserted into generated output

Expand Down Expand Up @@ -325,15 +325,15 @@ Sample code::
x = random.getrandbits(64)
print("{}".format(x))

+--------------------------+--------------------------------------------+
| CPy output: | uPy output: |
+--------------------------+--------------------------------------------+
| :: | :: |
| | |
| 16149866429655178725 | Traceback (most recent call last): |
| | File "<stdin>", line 11, in <module> |
| | ValueError: bits must be 32 or less |
+--------------------------+--------------------------------------------+
+-------------------------+--------------------------------------------+
| CPy output: | uPy output: |
+-------------------------+--------------------------------------------+
| :: | :: |
| | |
| 1755457232431556631 | Traceback (most recent call last): |
| | File "<stdin>", line 11, in <module> |
| | ValueError: bits must be 32 or less |
+-------------------------+--------------------------------------------+

.. _cpydiff_modules_random_randint:

Expand All @@ -358,7 +358,7 @@ Sample code::
+-----------------------------------------------+-----------------------------------------------------------------+
| :: | :: |
| | |
| x=340282366920938463463374607431768211455 | Traceback (most recent call last): |
| x=340282366920938463463374607431768211456 | Traceback (most recent call last): |
| | File "<stdin>", line 11, in <module> |
| | OverflowError: overflow converting long int to machine word |
+-----------------------------------------------+-----------------------------------------------------------------+
Expand Down
24 changes: 14 additions & 10 deletions docs/genrst/syntax.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

Syntax
======
Generated Tue 23 Jul 2024 04:46:38 UTC
Generated Wed 31 Jul 2024 20:47:23 UTC

.. _cpydiff_syntax_arg_unpacking:

Expand Down Expand Up @@ -91,15 +91,19 @@ Sample code::
except SyntaxError:
print("Should have worked")

+-------------+------------------------+
| CPy output: | uPy output: |
+-------------+------------------------+
| :: | :: |
| | |
| 0 | Should have worked |
| 1 | Should have worked |
| 1 | Should have worked |
+-------------+------------------------+
+--------------------------------------------------------+------------------------+
| CPy output: | uPy output: |
+--------------------------------------------------------+------------------------+
| :: | :: |
| | |
| 0 | Should have worked |
| 1 | Should have worked |
| 1 | Should have worked |
| <string>:1: SyntaxWarning: invalid decimal literal | |
| <string>:1: SyntaxWarning: invalid decimal literal | |
| <string>:1: SyntaxWarning: invalid decimal literal | |
| <string>:1: SyntaxWarning: invalid decimal literal | |
+--------------------------------------------------------+------------------------+

Unicode
-------
Expand Down
4 changes: 2 additions & 2 deletions docs/library/network.WINC.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -96,13 +96,13 @@ Constructors

.. method:: connected_sta()

This method returns a list containing the connected client's IP adress.
This method returns a list containing the connected client's IP address.

.. method:: wait_for_sta(timeout)

This method blocks and waits for a client to connect. If timeout is 0
this will block forever. This method returns a list containing the
connected client's IP adress.
connected client's IP address.

.. method:: ifconfig([ip_addr, subnet_addr, gateway_addr, dns_addr])

Expand Down
2 changes: 1 addition & 1 deletion docs/library/omv.audio.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ Functions
``highpass`` is the high pass filter cut-off given the target sample frequency. This parameter
is applicable for the Arduino Portenta H7 only.

``samples`` is the number of samples to accumulate per callback. This is typically caluclated
``samples`` is the number of samples to accumulate per callback. This is typically calculated
based on the decimation factor and number of channels. If set to -1, the number of samples
will be calculated automatically based on the decimation factor and number of channels.

Expand Down
Loading
Loading