diff options
author | Mike Causer <mcauser@gmail.com> | 2016-08-01 09:52:00 +1000 |
---|---|---|
committer | Paul Sokolovsky <pfalcon@users.sourceforge.net> | 2016-08-02 11:17:46 +0300 |
commit | ce166e6b68b7fafb73a99fd64081f8a4155fe22a (patch) | |
tree | 20b063465b430968482cea18c41f949fbd2ec845 /docs/library | |
parent | 3eb532e97463b7f9b9ffe6f617a035284ef3e37b (diff) | |
download | micropython-ce166e6b68b7fafb73a99fd64081f8a4155fe22a.tar.gz micropython-ce166e6b68b7fafb73a99fd64081f8a4155fe22a.zip |
docs: Spelling mistakes
Diffstat (limited to 'docs/library')
-rw-r--r-- | docs/library/builtins.rst | 2 | ||||
-rw-r--r-- | docs/library/esp.rst | 2 | ||||
-rw-r--r-- | docs/library/machine.Pin.rst | 2 | ||||
-rw-r--r-- | docs/library/machine.RTC.rst | 2 | ||||
-rw-r--r-- | docs/library/machine.SPI.rst | 2 | ||||
-rw-r--r-- | docs/library/machine.Timer.rst | 4 | ||||
-rw-r--r-- | docs/library/machine.UART.rst | 2 | ||||
-rw-r--r-- | docs/library/machine.rst | 4 | ||||
-rw-r--r-- | docs/library/network.rst | 12 | ||||
-rw-r--r-- | docs/library/pyb.ADC.rst | 2 | ||||
-rw-r--r-- | docs/library/pyb.DAC.rst | 2 | ||||
-rw-r--r-- | docs/library/pyb.ExtInt.rst | 4 | ||||
-rw-r--r-- | docs/library/pyb.I2C.rst | 2 | ||||
-rw-r--r-- | docs/library/pyb.Pin.rst | 4 | ||||
-rw-r--r-- | docs/library/pyb.RTC.rst | 2 | ||||
-rw-r--r-- | docs/library/pyb.Timer.rst | 10 | ||||
-rw-r--r-- | docs/library/pyb.rst | 4 | ||||
-rw-r--r-- | docs/library/ubinascii.rst | 2 | ||||
-rw-r--r-- | docs/library/ucollections.rst | 4 | ||||
-rw-r--r-- | docs/library/uctypes.rst | 4 | ||||
-rw-r--r-- | docs/library/uhashlib.rst | 6 | ||||
-rw-r--r-- | docs/library/uio.rst | 2 | ||||
-rw-r--r-- | docs/library/uos.rst | 2 | ||||
-rw-r--r-- | docs/library/utime.rst | 2 |
24 files changed, 42 insertions, 42 deletions
diff --git a/docs/library/builtins.rst b/docs/library/builtins.rst index d99eadce3e..42768ab999 100644 --- a/docs/library/builtins.rst +++ b/docs/library/builtins.rst @@ -1,7 +1,7 @@ Builtin Functions ================= -All builtin functions are described here. They are alse available via +All builtin functions are described here. They are also available via ``builtins`` module. .. function:: abs() diff --git a/docs/library/esp.rst b/docs/library/esp.rst index 34d3c278d9..0836bba72e 100644 --- a/docs/library/esp.rst +++ b/docs/library/esp.rst @@ -15,7 +15,7 @@ Functions Get or set the sleep type. If the ``sleep_type`` parameter is provided, sets the sleep type to its - value. If the function is called wihout parameters, returns the current + value. If the function is called without parameters, returns the current sleep type. The possible sleep types are defined as constants: diff --git a/docs/library/machine.Pin.rst b/docs/library/machine.Pin.rst index fdada2f383..db25787f94 100644 --- a/docs/library/machine.Pin.rst +++ b/docs/library/machine.Pin.rst @@ -84,7 +84,7 @@ Methods - ``None`` - no pull up or down resistor. - ``Pin.PULL_UP`` - pull up resistor enabled. - - ``Pin.PULL_DOWN`` - pull down resitor enabled. + - ``Pin.PULL_DOWN`` - pull down resistor enabled. - ``drive`` can be one of: diff --git a/docs/library/machine.RTC.rst b/docs/library/machine.RTC.rst index b6e98e9d1f..6dc8b3e9ab 100644 --- a/docs/library/machine.RTC.rst +++ b/docs/library/machine.RTC.rst @@ -39,7 +39,7 @@ Methods .. method:: RTC.alarm(id, time, /*, repeat=False) - Set the RTC alarm. Time might be either a milllisecond value to program the alarm to + Set the RTC alarm. Time might be either a millisecond value to program the alarm to current time + time_in_ms in the future, or a datetimetuple. If the time passed is in milliseconds, repeat can be set to ``True`` to make the alarm periodic. diff --git a/docs/library/machine.SPI.rst b/docs/library/machine.SPI.rst index f3c95181dc..73b3a3996d 100644 --- a/docs/library/machine.SPI.rst +++ b/docs/library/machine.SPI.rst @@ -45,7 +45,7 @@ Methods respectively. - ``bits`` is the width of each transfer, accepted values are 8, 16 and 32. - ``firstbit`` can be ``SPI.MSB`` only. - - ``pins`` is an optional tupple with the pins to assign to the SPI bus. + - ``pins`` is an optional tuple with the pins to assign to the SPI bus. .. method:: SPI.deinit() diff --git a/docs/library/machine.Timer.rst b/docs/library/machine.Timer.rst index 344d1ea86e..12db58d5c4 100644 --- a/docs/library/machine.Timer.rst +++ b/docs/library/machine.Timer.rst @@ -104,7 +104,7 @@ Methods If only a channel identifier passed, then a previously initialized channel object is returned (or ``None`` if there is no previous channel). - Othwerwise, a TimerChannel object is initialized and returned. + Otherwise, a TimerChannel object is initialized and returned. The operating mode is is the one configured to the Timer object that was used to create the channel. @@ -152,7 +152,7 @@ Methods .. method:: timerchannel.irq(\*, trigger, priority=1, handler=None) - The behavior of this callback is heaviliy dependent on the operating + The behavior of this callback is heavily dependent on the operating mode of the timer channel: - If mode is ``Timer.PERIODIC`` the callback is executed periodically diff --git a/docs/library/machine.UART.rst b/docs/library/machine.UART.rst index 27a8801900..f832cf4664 100644 --- a/docs/library/machine.UART.rst +++ b/docs/library/machine.UART.rst @@ -167,7 +167,7 @@ Methods .. data:: UART.EVEN .. data:: UART.ODD - parity types (anlong with ``None``) + parity types (along with ``None``) .. data:: UART.RX_ANY diff --git a/docs/library/machine.rst b/docs/library/machine.rst index b103ec393d..0f361a7cb7 100644 --- a/docs/library/machine.rst +++ b/docs/library/machine.rst @@ -57,7 +57,7 @@ Power related functions Gates the clock to the CPU, useful to reduce power consumption at any time during short or long periods. Peripherals continue working and execution resumes as soon as any interrupt is triggered (on many ports this includes system timer - interrupt occuring at regular intervals on the order of millisecond). + interrupt occurring at regular intervals on the order of millisecond). .. function:: sleep() @@ -96,7 +96,7 @@ Miscellaneous functions .. function:: unique_id() - Returns a byte string with a unique idenifier of a board/SoC. It will vary + Returns a byte string with a unique identifier of a board/SoC. It will vary from a board/SoC instance to another, if underlying hardware allows. Length varies by hardware (so use substring of a full value if you expect a short ID). In some MicroPython ports, ID corresponds to the network MAC address. diff --git a/docs/library/network.rst b/docs/library/network.rst index b183ef9a4b..0e18106aa8 100644 --- a/docs/library/network.rst +++ b/docs/library/network.rst @@ -237,7 +237,7 @@ For example:: Get or set the PHY mode. If the ``mode`` parameter is provided, sets the mode to its value. If - the function is called wihout parameters, returns the current mode. + the function is called without parameters, returns the current mode. The possible modes are defined as constants: * ``MODE_11B`` -- IEEE 802.11b, @@ -319,7 +319,7 @@ For example:: * ``STAT_WRONG_PASSWORD`` -- failed due to incorrect password, * ``STAT_NO_AP_FOUND`` -- failed because no access point replied, * ``STAT_CONNECT_FAIL`` -- failed due to other problems, - * ``STAT_GOT_IP`` -- connection susccessful. + * ``STAT_GOT_IP`` -- connection successful. .. method:: wlan.isconnected() @@ -329,7 +329,7 @@ For example:: .. method:: wlan.ifconfig([(ip, subnet, gateway, dns)]) - Get/set IP-level network interface paremeters: IP address, subnet mask, + Get/set IP-level network interface parameters: IP address, subnet mask, gateway and DNS server. When called with no arguments, this method returns a 4-tuple with the above information. To set the above values, pass a 4-tuple with the required information. For example:: @@ -343,8 +343,8 @@ For example:: with additional parameters beyond standard IP configuration (as dealt with by ``wlan.ifconfig()``). These include network-specific and hardware-specific parameters. For setting parameters, keyword argument syntax should be used, - multiple parameters can be set at once. For querying, paremeters name should - be quoted as a string, and only one paramter can be queries at time:: + multiple parameters can be set at once. For querying, parameters name should + be quoted as a string, and only one parameter can be queries at time:: # Set WiFi access point name (formally known as ESSID) and WiFi channel ap.config(essid='My AP', channel=11) @@ -397,7 +397,7 @@ For example:: .. note:: The ``WLAN`` constructor is special in the sense that if no arguments besides the id are given, - it will return the already exisiting ``WLAN`` instance without re-configuring it. This is + it will return the already existing ``WLAN`` instance without re-configuring it. This is because ``WLAN`` is a system feature of the WiPy. If the already existing instance is not initialized it will do the same as the other constructors an will initialize it with default values. diff --git a/docs/library/pyb.ADC.rst b/docs/library/pyb.ADC.rst index 2ffd4e16f5..51021fdc1a 100644 --- a/docs/library/pyb.ADC.rst +++ b/docs/library/pyb.ADC.rst @@ -13,7 +13,7 @@ class ADC -- analog to digital conversion adc = pyb.ADC(pin) # create an analog object from a pin val = adc.read() # read an analog value - adc = pyb.ADCAll(resolution) # creale an ADCAll object + adc = pyb.ADCAll(resolution) # create an ADCAll object val = adc.read_channel(channel) # read the given channel val = adc.read_core_temp() # read MCU temperature val = adc.read_core_vbat() # read MCU VBAT diff --git a/docs/library/pyb.DAC.rst b/docs/library/pyb.DAC.rst index 4b9651e27e..fd786b63b6 100644 --- a/docs/library/pyb.DAC.rst +++ b/docs/library/pyb.DAC.rst @@ -79,7 +79,7 @@ Methods .. method:: DAC.triangle(freq) Generate a triangle wave. The value on the DAC output changes at - the given frequency, and the frequence of the repeating triangle wave + the given frequency, and the frequency of the repeating triangle wave itself is 2048 times smaller. .. method:: DAC.write(value) diff --git a/docs/library/pyb.ExtInt.rst b/docs/library/pyb.ExtInt.rst index d8f4d92bb8..814217cef0 100644 --- a/docs/library/pyb.ExtInt.rst +++ b/docs/library/pyb.ExtInt.rst @@ -7,7 +7,7 @@ class ExtInt -- configure I/O pins to interrupt on external events There are a total of 22 interrupt lines. 16 of these can come from GPIO pins and the remaining 6 are from internal sources. -For lines 0 thru 15, a given line can map to the corresponding line from an +For lines 0 through 15, a given line can map to the corresponding line from an arbitrary port. So line 0 can map to Px0 where x is A, B, C, ... and line 1 can map to Px1 where x is A, B, C, ... :: @@ -27,7 +27,7 @@ explanation, along with various techniques for debouncing. Trying to register 2 callbacks onto the same pin will throw an exception. If pin is passed as an integer, then it is assumed to map to one of the -internal interrupt sources, and must be in the range 16 thru 22. +internal interrupt sources, and must be in the range 16 through 22. All other pin objects go through the pin mapper to come up with one of the gpio pins. :: diff --git a/docs/library/pyb.I2C.rst b/docs/library/pyb.I2C.rst index 210b4ccf21..67131feec0 100644 --- a/docs/library/pyb.I2C.rst +++ b/docs/library/pyb.I2C.rst @@ -39,7 +39,7 @@ Printing the i2c object gives you information about its configuration. You can specify a timeout (in ms):: - i2c.send(b'123', timeout=2000) # timout after 2 seconds + i2c.send(b'123', timeout=2000) # timeout after 2 seconds A master must specify the recipient's address:: diff --git a/docs/library/pyb.Pin.rst b/docs/library/pyb.Pin.rst index 154217ebb7..4f589fff89 100644 --- a/docs/library/pyb.Pin.rst +++ b/docs/library/pyb.Pin.rst @@ -231,7 +231,7 @@ Constants class PinAF -- Pin Alternate Functions ====================================== - A Pin represents a physical pin on the microcprocessor. Each pin + A Pin represents a physical pin on the microprocessor. Each pin can have a variety of functions (GPIO, I2C SDA, etc). Each PinAF object represents a particular function for a pin. @@ -240,7 +240,7 @@ Constants x3 = pyb.Pin.board.X3 x3_af = x3.af_list() - x3_af will now contain an array of PinAF objects which are availble on + x3_af will now contain an array of PinAF objects which are available on pin X3. For the pyboard, x3_af would contain: diff --git a/docs/library/pyb.RTC.rst b/docs/library/pyb.RTC.rst index 383ddf20c2..2628554526 100644 --- a/docs/library/pyb.RTC.rst +++ b/docs/library/pyb.RTC.rst @@ -73,7 +73,7 @@ Methods value, which is an integer in the range [-511 : 512]. With one argument it sets the RTC calibration. - The RTC Smooth Calibration mechanism addjusts the RTC clock rate by + The RTC Smooth Calibration mechanism adjusts the RTC clock rate by adding or subtracting the given number of ticks from the 32768 Hz clock over a 32 second period (corresponding to 2^20 clock ticks.) Each tick added will speed up the clock by 1 part in 2^20, or 0.954 diff --git a/docs/library/pyb.Timer.rst b/docs/library/pyb.Timer.rst index ffb092caa3..052bce2efd 100644 --- a/docs/library/pyb.Timer.rst +++ b/docs/library/pyb.Timer.rst @@ -78,7 +78,7 @@ Methods Keyword arguments: - - ``freq`` --- specifies the periodic frequency of the timer. You migh also + - ``freq`` --- specifies the periodic frequency of the timer. You might also view this as the frequency with which the timer goes through one complete cycle. - ``prescaler`` [0-0xffff] - specifies the value to be loaded into the @@ -97,7 +97,7 @@ Methods - ``Timer.UP`` - configures the timer to count from 0 to ARR (default) - ``Timer.DOWN`` - configures the timer to count from ARR down to 0. - - ``Timer.CENTER`` - confgures the timer to count from 0 to ARR and + - ``Timer.CENTER`` - configures the timer to count from 0 to ARR and then back down to 0. - ``div`` can be one of 1, 2, or 4. Divides the timer clock to determine @@ -109,7 +109,7 @@ Methods transitions on complimentary channels (both channels will be inactive) for this time). ``deadtime`` may be an integer between 0 and 1008, with the following restrictions: 0-128 in steps of 1. 128-256 in steps of - 2, 256-512 in steps of 8, and 512-1008 in steps of 16. ``deadime`` + 2, 256-512 in steps of 8, and 512-1008 in steps of 16. ``deadtime`` measures ticks of ``source_freq`` divided by ``div`` clock ticks. ``deadtime`` is only available on timers 1 and 8. @@ -141,7 +141,7 @@ Methods If only a channel number is passed, then a previously initialized channel object is returned (or ``None`` if there is no previous channel). - Othwerwise, a TimerChannel object is initialized and returned. + Otherwise, a TimerChannel object is initialized and returned. Each channel can be configured to perform pwm, output compare, or input capture. All channels share the same underlying timer, which means @@ -183,7 +183,7 @@ Methods - ``polarity`` can be one of: - ``Timer.HIGH`` - output is active high - - ``Timer.LOW`` - output is acive low + - ``Timer.LOW`` - output is active low Optional keyword arguments for Timer.IC modes: diff --git a/docs/library/pyb.rst b/docs/library/pyb.rst index 7be39a5d8e..2f3e7d36bd 100644 --- a/docs/library/pyb.rst +++ b/docs/library/pyb.rst @@ -46,7 +46,7 @@ Time related functions Returns the number of milliseconds which have elapsed since ``start``. This function takes care of counter wrap, and always returns a positive - number. This means it can be used to measure periods upto about 12.4 days. + number. This means it can be used to measure periods up to about 12.4 days. Example:: @@ -59,7 +59,7 @@ Time related functions Returns the number of microseconds which have elapsed since ``start``. This function takes care of counter wrap, and always returns a positive - number. This means it can be used to measure periods upto about 17.8 minutes. + number. This means it can be used to measure periods up to about 17.8 minutes. Example:: diff --git a/docs/library/ubinascii.rst b/docs/library/ubinascii.rst index 0a9adb50d4..4931f90482 100644 --- a/docs/library/ubinascii.rst +++ b/docs/library/ubinascii.rst @@ -17,7 +17,7 @@ Functions .. admonition:: Difference to CPython :class: attention - If additional argument, `sep` is supplied, it is used as a seperator + If additional argument, `sep` is supplied, it is used as a separator between hexadecimal values. .. function:: unhexlify(data) diff --git a/docs/library/ucollections.rst b/docs/library/ucollections.rst index c7ed068c7e..4e9de9ac67 100644 --- a/docs/library/ucollections.rst +++ b/docs/library/ucollections.rst @@ -13,10 +13,10 @@ Classes .. function:: namedtuple(name, fields) This is factory function to create a new namedtuple type with a specific - name and set of fields. A namedtyple is a subclass of tuple which allows + name and set of fields. A namedtuple is a subclass of tuple which allows to access its fields not just by numeric index, but also with an attribute access syntax using symbolic field names. Fields is a sequence of strings - specifying field names. For compatibily with CPython it can also be a + specifying field names. For compatibility with CPython it can also be a a string with space-separated field named (but this is less efficient). Example of use:: diff --git a/docs/library/uctypes.rst b/docs/library/uctypes.rst index 630a3a36fb..2a9c4dd5c0 100644 --- a/docs/library/uctypes.rst +++ b/docs/library/uctypes.rst @@ -118,7 +118,7 @@ Module contents .. data:: BIG_ENDIAN - Layour type for a big-endian packed structure. + Layout type for a big-endian packed structure. .. data:: NATIVE @@ -184,7 +184,7 @@ Subscripting a pointer with other integer values but 0 are supported too, with the same semantics as in C. Summing up, accessing structure fields generally follows C syntax, -except for pointer derefence, when you need to use ``[0]`` operator +except for pointer dereference, when you need to use ``[0]`` operator instead of ``*``. Limitations diff --git a/docs/library/uhashlib.rst b/docs/library/uhashlib.rst index 5de4b6f7ba..223c72dfe7 100644 --- a/docs/library/uhashlib.rst +++ b/docs/library/uhashlib.rst @@ -9,7 +9,7 @@ This module implements binary data hashing algorithms. Currently, it implements SHA256 algorithm. Choosing SHA256 was a deliberate choice, as a modern, cryptographically secure algorithm. This means that a - single algorithm can cover both usecases of "any hash algorithm" and + single algorithm can cover both use cases of "any hash algorithm" and security-related usage, and thus save space omitting legacy algorithms like MD5 or SHA1. @@ -53,7 +53,7 @@ Constructors Example:: - hash = uhashlib.sha1('abcd1234', 1001) # lenght of the initial piece is multiple of 4 bytes + hash = uhashlib.sha1('abcd1234', 1001) # length of the initial piece is multiple of 4 bytes hash.update('1234') # also multiple of 4 bytes ... hash.update('12345') # last chunk may be of any length @@ -68,7 +68,7 @@ Methods .. method:: hash.digest() - Return hash for all data passed thru hash, as a bytes object. After this + Return hash for all data passed through hash, as a bytes object. After this method is called, more data cannot be fed into hash any longer. .. only:: port_wipy diff --git a/docs/library/uio.rst b/docs/library/uio.rst index 1b3e2a0822..1823df8c4c 100644 --- a/docs/library/uio.rst +++ b/docs/library/uio.rst @@ -12,7 +12,7 @@ Functions .. function:: open(name, mode='r', **kwargs) - Open a file. Builtin ``open()`` function is alised to this function. + Open a file. Builtin ``open()`` function is aliased to this function. All ports (which provide access to file system) are required to support `mode` parameter, but support for other arguments vary by port. diff --git a/docs/library/uos.rst b/docs/library/uos.rst index bb95107c04..77a61ca449 100644 --- a/docs/library/uos.rst +++ b/docs/library/uos.rst @@ -81,7 +81,7 @@ Functions .. function:: unmount(path) - Unmounts a prevoulsy mounted block device from the given path. + Unmounts a previously mounted block device from the given path. .. function:: mkfs(block_device or path) diff --git a/docs/library/utime.rst b/docs/library/utime.rst index 0bca4692ac..8310673830 100644 --- a/docs/library/utime.rst +++ b/docs/library/utime.rst @@ -117,7 +117,7 @@ Functions .. function:: time() Returns the number of seconds, as an integer, since the Epoch, assuming that underlying - RTC is set and maintained as decsribed above. If an RTC is not set, this function returns + RTC is set and maintained as described above. If an RTC is not set, this function returns number of seconds since a port-specific reference point in time (for embedded boards without a battery-backed RTC, usually since power up or reset). If you want to develop portable MicroPython application, you should not rely on this function to provide higher than second |