Skip to content

Conversation

@Josverl
Copy link
Contributor

@Josverl Josverl commented Nov 13, 2025

This PR combines a few rather minor fixes of typos in documentation and scripts.

  • Update the aioble example to use the correct advertising interval constant name.
  • Correct the README to reference the appropriate public address constant.
  • Fix a typo in the deepcopy function to reference the correct dispatch table.

Fixes #1055, #699, #952

@Josverl Josverl added the docs label Nov 13, 2025
@Josverl Josverl force-pushed the doc_updates branch 3 times, most recently from c6bd535 to e8c0a9c Compare November 13, 2025 02:54
Copy link
Member

@dpgeorge dpgeorge left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for this, there are some good fixes here.

I approve all commits except the RST formatting one.

----------------------------------------------------------------------------
This is a copy of python's Cmd, but leaves out features that aren't relevant
or can't currently be implemented for MicroPython.
.. caution::
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I really don't think we should be using RST formatting here.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

.Rst dropped

heapify(x) # transforms list into a heap, in-place, in linear time
item = heapreplace(heap, item) # pops and returns smallest item, and adds
# new item; the heap size is unchanged
heap = [] # creates an empty heap
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Why not 4 space indent like the other example code reformatted in this PR?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

thanks, missed that

@Josverl
Copy link
Contributor Author

Josverl commented Nov 14, 2025

The rst formatting was a side effect of the work I started with @jimmo to see if/how it would be possible to generate documentation pages from the source files.
Some of the existing docstrings were half-and-half RST and plaintext with a bit of .MD as well.

I have reverted the RST formatting to plaintext.

For a separate PR:
Using Sphinx-AutoAPI it should be rather simple to add documentation for the 3 categories of modules (micropython - stdlib - community) to the existing documentation. IMO That would close a discoverability and documentation gap.
Sphinx + Auto-API should be able to handle a mix of RST and MarkDown formats by enablingMyST as well.

Fixes issue micropython#1055.

Signed-off-by: Jos Verlinde <Jos_Verlinde@hotmail.com>
Fixes issue micropython#699.

Signed-off-by: Jos Verlinde <Jos_Verlinde@hotmail.com>
Fixes issue micropython#952.

Signed-off-by: Jos Verlinde <Jos_Verlinde@hotmail.com>
This is a working alternative to PR micropython#919.

Signed-off-by: Jos Verlinde <Jos_Verlinde@hotmail.com>
No changes to versions as only comments and docstrings changed

Signed-off-by: Jos Verlinde <Jos_Verlinde@hotmail.com>
Signed-off-by: Jos Verlinde <Jos_Verlinde@hotmail.com>
@dpgeorge dpgeorge merged commit bfd33d5 into micropython:master Nov 18, 2025
4 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Example should say "..._US".

2 participants