-
-
Notifications
You must be signed in to change notification settings - Fork 8.5k
all,tools: Retire the terms uPy, uPython. #18128
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
Conversation
560e5ab to
0b435ae
Compare
|
There is one place where |
|
Code size report: |
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## master #18128 +/- ##
=======================================
Coverage 98.39% 98.39%
=======================================
Files 171 171
Lines 22276 22276
=======================================
Hits 21918 21918
Misses 358 358 ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
|
Thanks for doing this! I think it's a good change, there are a quite a lot of places where uPy -> MicroPython is an obvious improvement. But for the changes where uPy -> MP ... I'm not sure it's always clear what "MP" stands for? Maybe use "MPy"/"MPY"??
I think we can change this. It's just the first string printed by that test, see |
|
I find MPy clearer |
|
In the CircuitPython world we do say "CPy" for CircuitPython, but never in documentation, just on discord, etc., to save typing. Sometimes we say "CircPy" for short. If comparing with MicroPython, "MPy" vs "CPy" is usually clear, in context. "CPython" is pretty confusing as well, because that name is rarely used by ordinary Python users, especially novices., and sounds like it might be an abbreviation for CircuitPython. So we (or at least I) say "regular Python" a lot when discussing CPython. |
Maybe change "uPy" to "interned" in this test? That makes it clear exactly what it's testing. |
0b435ae to
96ba69e
Compare
dpgeorge
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This looks good now, thanks.
I don't know if uPy and uPython causes confusion for people new to MicroPython, but potentially it could (one more set of terms to learn). Consistency is good to have.
IMO this is the strongest argument in favour of this change: a newcomer seeing "uPython" could potentially be confused as to what it refers to (and thinks "is there a difference between uPython and MicroPython?").
Abbreviating these doesn't really save space in the docs, as the code blocks in the next row are always wider than the column headings. Signed-off-by: Angus Gratton <angus@redyak.com.au>
cfd991d to
d328984
Compare
With the aim of getting consistency, and removing the need to learn an additional term, replace uses of uPy/uPython with MPy/MicroPython. Rule of thumb was to use "MPy" abbreviation where "CPy" is used nearby, but the full word MicroPython otherwise. This work was funded through GitHub Sponsors. Signed-off-by: Angus Gratton <angus@redyak.com.au>
d328984 to
3ec8b9a
Compare
Summary
As suggested by @Josverl in #18057, this PR retires the legacy terms
uPy,uPython.and adds codespell configuration to check for them in CI.(EDIT: Have taken the Codespell changes out as Damien reasonably pointed out that no one is likely to add these terms back any time soon.)
In the last commit of this PR, uPy is bulk replaced with:
I also made a couple of opportunistic replacements of cPy with the more common CPy.
There is also a commit to change the "Differences to CPython" generation. Previously it generated tables with headings CPy Output and uPy Output. Now it is CPython Output and MicroPython Output. The code block below the heading in each column is always wider than the heading, so there's no need to abbreviate here.
Trade-offs and Alternatives
We could simply not do this.
I don't know if uPy and uPython causes confusion for people new to MicroPython, but potentially it could (one more set of terms to learn). Consistency is good to have.