summaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorMike Causer <mcauser@gmail.com>2020-12-10 02:52:18 +1100
committerMike Causer <mcauser@gmail.com>2020-12-10 02:52:18 +1100
commiteedcc98cc5379f93704fd344289e2f5c8a60eddd (patch)
treeb0edae3059a39b367317b9acd7057c3b8475abcb /docs
parent133013083ab582fa87a4c7dfb53d068e09864905 (diff)
Fix some spelling mistakes
Diffstat (limited to 'docs')
-rw-r--r--docs/design_guide.rst8
-rw-r--r--docs/drivers.rst2
-rw-r--r--docs/library/hashlib.rst4
-rw-r--r--docs/library/index.rst4
-rw-r--r--docs/library/network.rst2
-rw-r--r--docs/porting.rst2
-rw-r--r--docs/troubleshooting.rst4
7 files changed, 13 insertions, 13 deletions
diff --git a/docs/design_guide.rst b/docs/design_guide.rst
index cc2a3b296..75825893a 100644
--- a/docs/design_guide.rst
+++ b/docs/design_guide.rst
@@ -421,7 +421,7 @@ SPI Example
"""Widget's one register."""
with self.spi_device as spi:
spi.write(b'0x00')
- i2c.readinto(self.buf)
+ spi.readinto(self.buf)
return self.buf[0]
Use composition
@@ -462,7 +462,7 @@ like properties for state even if it sacrifices a bit of speed.
Avoid allocations in drivers
--------------------------------------------------------------------------------
-Although Python doesn't require managing memory, its still a good practice for
+Although Python doesn't require managing memory, it's still a good practice for
library writers to think about memory allocations. Avoid them in drivers if
you can because you never know how much something will be called. Fewer
allocations means less time spent cleaning up. So, where you can, prefer
@@ -471,7 +471,7 @@ object with methods that read or write into the buffer instead of creating new
objects. Unified hardware API classes such as `busio.SPI` are design to read and
write to subsections of buffers.
-Its ok to allocate an object to return to the user. Just beware of causing more
+It's ok to allocate an object to return to the user. Just beware of causing more
than one allocation per call due to internal logic.
**However**, this is a memory tradeoff so do not do it for large or rarely used
@@ -580,4 +580,4 @@ MicroPython compatibility
--------------------------------------------------------------------------------
Keeping compatibility with MicroPython isn't a high priority. It should be done
-when its not in conflict with any of the above goals.
+when it's not in conflict with any of the above goals.
diff --git a/docs/drivers.rst b/docs/drivers.rst
index 241415cc1..8855abbd2 100644
--- a/docs/drivers.rst
+++ b/docs/drivers.rst
@@ -12,7 +12,7 @@ Adafruit CircuitPython Library Bundle
We provide a bundle of all our libraries to ease installation of drivers and
their dependencies. The bundle is primarily geared to the Adafruit Express line
of boards which feature a relatively large external flash. With Express boards,
-its easy to copy them all onto the filesystem. However, if you don't have
+it's easy to copy them all onto the filesystem. However, if you don't have
enough space simply copy things over as they are needed.
- The Adafruit bundles are available on GitHub: <https://github.com/adafruit/Adafruit_CircuitPython_Bundle/releases>.
diff --git a/docs/library/hashlib.rst b/docs/library/hashlib.rst
index 0205d5e6a..8e5ebc2d1 100644
--- a/docs/library/hashlib.rst
+++ b/docs/library/hashlib.rst
@@ -20,10 +20,10 @@ be implemented:
* SHA1 - A previous generation algorithm. Not recommended for new usages,
but SHA1 is a part of number of Internet standards and existing
applications, so boards targeting network connectivity and
- interoperatiability will try to provide this.
+ interoperability will try to provide this.
* MD5 - A legacy algorithm, not considered cryptographically secure. Only
- selected boards, targeting interoperatibility with legacy applications,
+ selected boards, targeting interoperability with legacy applications,
will offer this.
Constructors
diff --git a/docs/library/index.rst b/docs/library/index.rst
index f847ead0a..e91387242 100644
--- a/docs/library/index.rst
+++ b/docs/library/index.rst
@@ -21,7 +21,7 @@ standard Python library.
You may need to change your code later if you rely
on any non-standard functionality they currently provide.
-CircuitPython's goal long-term goalis that code written in CircuitPython
+CircuitPython's long-term goal is that code written in CircuitPython
using Python standard libraries will be runnable on CPython without changes.
Some libraries below are not enabled on CircuitPython builds with
@@ -69,7 +69,7 @@ CircuitPython/MicroPython-specific libraries
--------------------------------------------
Functionality specific to the CircuitPython/MicroPython implementation is available in
-the following libraries. These libraries may change signficantly or be removed in future
+the following libraries. These libraries may change significantly or be removed in future
versions of CircuitPython.
.. toctree::
diff --git a/docs/library/network.rst b/docs/library/network.rst
index bd32267fe..3bd41150d 100644
--- a/docs/library/network.rst
+++ b/docs/library/network.rst
@@ -71,7 +71,7 @@ parameter should be `id`.
(password) required to access said service. There can be further
arbitrary keyword-only parameters, depending on the networking medium
type and/or particular device. Parameters can be used to: a)
- specify alternative service identifer types; b) provide additional
+ specify alternative service identifier types; b) provide additional
connection parameters. For various medium types, there are different
sets of predefined/recommended parameters, among them:
diff --git a/docs/porting.rst b/docs/porting.rst
index 6cd59fefb..8d0262455 100644
--- a/docs/porting.rst
+++ b/docs/porting.rst
@@ -106,7 +106,7 @@ request a safe mode state which prevents the supervisor from running user code
while still allowing access to the REPL and other resources.
The core port initialization and reset methods are defined in
-``supervisor/port.c`` and should be the first to be implemented. Its required
+``supervisor/port.c`` and should be the first to be implemented. It's required
that they be implemented in the ``supervisor`` directory within the port
directory. That way, they are always in the expected place.
diff --git a/docs/troubleshooting.rst b/docs/troubleshooting.rst
index 66bcc2764..45c637f34 100644
--- a/docs/troubleshooting.rst
+++ b/docs/troubleshooting.rst
@@ -13,7 +13,7 @@ When CircuitPython restarts it will create a fresh empty ``CIRCUITPY`` filesyste
This often happens on Windows when the ``CIRCUITPY`` disk is not safely ejected
before being reset by the button or being disconnected from USB. This can also
-happen on Linux and Mac OSX but its less likely.
+happen on Linux and Mac OSX but it's less likely.
.. caution:: To erase and re-create ``CIRCUITPY`` (for example, to correct a corrupted filesystem),
follow one of the procedures below. It's important to note that **any files stored on the**
@@ -43,7 +43,7 @@ ValueError: Incompatible ``.mpy`` file.
This error occurs when importing a module that is stored as a ``mpy`` binary file
(rather than a ``py`` text file) that was generated by a different version of
-CircuitPython than the one its being loaded into. Most versions are compatible
+CircuitPython than the one it's being loaded into. Most versions are compatible
but, rarely they aren't. In particular, the ``mpy`` binary format changed between
CircuitPython versions 1.x and 2.x, and will change again between 2.x and 3.x.