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

docs: Fix typos in README.md #14416

Open
2 tasks done
th4ruka opened this issue May 3, 2024 · 1 comment
Open
2 tasks done

docs: Fix typos in README.md #14416

th4ruka opened this issue May 3, 2024 · 1 comment

Comments

@th4ruka
Copy link

th4ruka commented May 3, 2024

Checks

  • I agree to follow the MicroPython Code of Conduct to ensure a safe and respectful space for everyone.

  • I've searched for existing issues and didn't find any that matched.

Documentation URL

https://github.com/micropython/micropython/blob/master/README.md

Description

I have found a few typos in the README.md. Following is an example,

Select ports have support for _thread module (multithreading), socket and ssl for networking, and asyncio. Note that only a subset of Python 3 functionality is implemented for the data types and modules.

Here, Select should be changed to Selected.
I would like to work on these typos and make a contribution to MicroPython.

@ma261065
Copy link
Sponsor

ma261065 commented Jun 3, 2024

While I'm sure there are typos in the documentation, you picked a controversial use of English as your example.

Many people now use "select" to imply a carefully chosen subset, such as "The awards were attended by a select group of celebrities".

One piece of guidance I have seen says:

Use "select" as an adjective to connote a desirable group of objects. Use "selected" as adjective to connote a neutral (even if purposeful) subsetting of objects from a larger universe.

So while I agree that "selected" would be the better choice here, perhaps we would be better off using more common language such as "Some ports have support for _thread module" and avoid the use of "advertising speak" for technical documentation.

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

No branches or pull requests

2 participants