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/reference/glossary.rst: New terms, reduce complexity. #5193

Closed
wants to merge 1 commit into from

Conversation

jimmo
Copy link
Member

@jimmo jimmo commented Oct 8, 2019

No description provided.

extract data from them (or make a copy).

CircuitPython
An alternate version of MicroPython developed by `Adafruit Industries
Copy link
Contributor

Choose a reason for hiding this comment

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

I think alternative might be more correct here?

However, a large subset of these modules require POSIX-like
environment (Linux, FreeBSD, MacOS, etc.; Windows may be partially
supported), and thus would work or make sense only on the `MicroPython
Unix port`. Some subset of modules are usable for the
Copy link
Contributor

Choose a reason for hiding this comment

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

Maybe add a short explanation that the main reason for this (i.e. most of it only being usable on POSIX-like) is that's it is implemented by ffi?

:term:`CPython`'s ``python`` executable.

.mpy file
The output of the cross compiler. A compiled form of a :term:`.py` file
Copy link
Contributor

Choose a reason for hiding this comment

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

Also use :term: for 'cross compiler'?

@jimmo
Copy link
Member Author

jimmo commented Oct 8, 2019

I think alternative might be more correct here?

You're absolutely right. However, I changed it to "A variant of MicroPython" which I think reads better.

Fixed the other comments too. Thanks!

@dpgeorge dpgeorge added the docs label Oct 9, 2019
@mcauser
Copy link
Contributor

mcauser commented Oct 9, 2019

Looks good. Found acryonym misspelled twice further down.
"acryonym" -> "acronym"

@mcauser
Copy link
Contributor

mcauser commented Oct 9, 2019

In upip: "A package manage" -> "A package manager"

@jimmo
Copy link
Member Author

jimmo commented Oct 9, 2019

"acryonym" -> "acronym"
In upip: "A package manage" -> "A package manager"

Fixed. Thanks!

@mattytrentini
Copy link
Sponsor Contributor

These descriptions are clearer to me @jimmo, thanks!

@dpgeorge
Copy link
Member

Thanks a lot! Merged in a93495b with some minor fixes to the cross references within the glossary itself.

@dpgeorge dpgeorge closed this Oct 15, 2019
tannewt pushed a commit to tannewt/circuitpython that referenced this pull request Aug 24, 2021
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.

None yet

5 participants