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.

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

Fix typos in README.md #14417

Open
wants to merge 4 commits into
base: master
Choose a base branch
from
Open

Conversation

th4ruka
Copy link
Sponsor

@th4ruka th4ruka commented May 3, 2024

This handles the fix addressed in issue #14416. Following changes have been made in README.md,

Selected Select ports have support for _thread module (multithreading), socket and ssl for networking, and asyncio.

  • Changed Select to Selected in the above sentence.

See the online documentation for API reference references and information about using MicroPython and information about how it is implemented.

  • Changed references to reference in the above sentence.

Signed-off-by: tharuka <78165134+tharuka-pavith@users.noreply.github.com>
@th4ruka th4ruka changed the title Fix typos in README.md #14416 Fix typos in README.md May 3, 2024
README.md Outdated
@@ -19,7 +19,7 @@ Python 3.5 and some select features from later versions). The following core
datatypes are provided: `str`(including basic Unicode support), `bytes`,
`bytearray`, `tuple`, `list`, `dict`, `set`, `frozenset`, `array.array`,
`collections.namedtuple`, classes and instances. Builtin modules include
`os`, `sys`, `time`, `re`, and `struct`, etc. Select ports have support for
`os`, `sys`, `time`, `re`, and `struct`, etc. Selected ports have support for
Copy link
Sponsor Contributor

Choose a reason for hiding this comment

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

Maybe more clear to say "Some" or "Certain"?

"Select ports" makes more sense to me than "Selected ports" though.

Copy link
Sponsor Author

Choose a reason for hiding this comment

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

Hi! Thanks for the feedback. I agree that Some or Certain could work well here. Some would be a better choice.

README.md Outdated Show resolved Hide resolved
@th4ruka th4ruka marked this pull request as draft May 4, 2024 02:24
th4ruka and others added 3 commits May 4, 2024 08:11
Co-authored-by: David Lechner <david@lechnology.com>
Signed-off-by: tharuka <78165134+tharuka-pavith@users.noreply.github.com>
Signed-off-by: tharuka <78165134+tharuka-pavith@users.noreply.github.com>
@th4ruka th4ruka marked this pull request as ready for review May 4, 2024 03:01
@th4ruka
Copy link
Sponsor Author

th4ruka commented May 4, 2024

I have made following changes according to the feedback given,

  • Replaced Selected with Some in port description.
  • Updated the online documentation sentence.

Would appreciate another review. @dlech

Copy link
Sponsor Contributor

@dlech dlech left a comment

Choose a reason for hiding this comment

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

Looks good to me.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants