djsundog/circuitpython
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Merge pull request #5028 from jepler/ulab-fix-docs

Browse Source 
ulab: move documentation to the right location
This commit is contained in:
Scott Shawcroft 2021-07-22 16:51:32 -07:00 committed by GitHub
commit 9c8c4a301d
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
4 changed files with 60 additions and 45 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
extmod/ulab

@ -1 +1 @@
Subproject commit 9b8cd47640304929aa4255560d754b3058ddaa95 Subproject commit 8d93ddeaf3548d5466cee0a392a4ee89f07ce2e5

92
locale/circuitpython.pot
View File

@ -2508,11 +2508,11 @@ msgstr ""
msgid "arg must be user-type" msgid "arg must be user-type"
msgstr "" msgstr ""
#: extmod/ulab/code/numpy/numerical/numerical.c #: extmod/ulab/code/numpy/numerical.c
msgid "argsort argument must be an ndarray" msgid "argsort argument must be an ndarray"
msgstr "" msgstr ""
#: extmod/ulab/code/numpy/numerical/numerical.c #: extmod/ulab/code/numpy/numerical.c
msgid "argsort is not implemented for flattened arrays" msgid "argsort is not implemented for flattened arrays"
msgstr "" msgstr ""
@ -2533,8 +2533,7 @@ msgstr ""
msgid "argument should be a '%q' not a '%q'" msgid "argument should be a '%q' not a '%q'"
msgstr "" msgstr ""
#: extmod/ulab/code/numpy/numerical/numerical.c #: extmod/ulab/code/numpy/numerical.c extmod/ulab/code/numpy/transform.c
#: extmod/ulab/code/numpy/transform/transform.c
msgid "arguments must be ndarrays" msgid "arguments must be ndarrays"
msgstr "" msgstr ""
@ -2547,11 +2546,11 @@ msgstr ""
msgid "array/bytes required on right side" msgid "array/bytes required on right side"
msgstr "" msgstr ""
#: extmod/ulab/code/numpy/numerical/numerical.c #: extmod/ulab/code/numpy/numerical.c
msgid "attempt to get (arg)min/(arg)max of empty sequence" msgid "attempt to get (arg)min/(arg)max of empty sequence"
msgstr "" msgstr ""
#: extmod/ulab/code/numpy/numerical/numerical.c #: extmod/ulab/code/numpy/numerical.c
msgid "attempt to get argmin/argmax of an empty sequence" msgid "attempt to get argmin/argmax of an empty sequence"
msgstr "" msgstr ""
@ -2559,15 +2558,15 @@ msgstr ""
msgid "attributes not supported yet" msgid "attributes not supported yet"
msgstr "" msgstr ""
#: extmod/ulab/code/numpy/numerical/numerical.c #: extmod/ulab/code/numpy/numerical.c
msgid "axis is out of bounds" msgid "axis is out of bounds"
msgstr "" msgstr ""
#: extmod/ulab/code/numpy/numerical/numerical.c extmod/ulab/code/ulab_tools.c #: extmod/ulab/code/numpy/numerical.c extmod/ulab/code/ulab_tools.c
msgid "axis must be None, or an integer" msgid "axis must be None, or an integer"
msgstr "" msgstr ""
#: extmod/ulab/code/numpy/numerical/numerical.c #: extmod/ulab/code/numpy/numerical.c
msgid "axis too long" msgid "axis too long"
msgstr "" msgstr ""
@ -2789,6 +2788,10 @@ msgid ""
"can't switch from manual field specification to automatic field numbering" "can't switch from manual field specification to automatic field numbering"
msgstr "" msgstr ""
#: extmod/ulab/code/ndarray.c
msgid "cannot assign new shape"
msgstr ""
#: extmod/ulab/code/ndarray_operators.c #: extmod/ulab/code/ndarray_operators.c
msgid "cannot cast output with casting rule" msgid "cannot cast output with casting rule"
msgstr "" msgstr ""
@ -2885,19 +2888,19 @@ msgstr ""
msgid "conversion to object" msgid "conversion to object"
msgstr "" msgstr ""
#: extmod/ulab/code/numpy/filter/filter.c #: extmod/ulab/code/numpy/filter.c
msgid "convolve arguments must be linear arrays" msgid "convolve arguments must be linear arrays"
msgstr "" msgstr ""
#: extmod/ulab/code/numpy/filter/filter.c #: extmod/ulab/code/numpy/filter.c
msgid "convolve arguments must be ndarrays" msgid "convolve arguments must be ndarrays"
msgstr "" msgstr ""
#: extmod/ulab/code/numpy/filter/filter.c #: extmod/ulab/code/numpy/filter.c
msgid "convolve arguments must not be empty" msgid "convolve arguments must not be empty"
msgstr "" msgstr ""
#: extmod/ulab/code/numpy/poly/poly.c #: extmod/ulab/code/numpy/poly.c
msgid "could not invert Vandermonde matrix" msgid "could not invert Vandermonde matrix"
msgstr "" msgstr ""
@ -2905,7 +2908,7 @@ msgstr ""
msgid "couldn't determine SD card version" msgid "couldn't determine SD card version"
msgstr "" msgstr ""
#: extmod/ulab/code/numpy/numerical/numerical.c #: extmod/ulab/code/numpy/numerical.c
msgid "cross is defined for 1D arrays of length 3" msgid "cross is defined for 1D arrays of length 3"
msgstr "" msgstr ""
@ -2955,15 +2958,15 @@ msgstr ""
msgid "dict update sequence has wrong length" msgid "dict update sequence has wrong length"
msgstr "" msgstr ""
#: extmod/ulab/code/numpy/numerical/numerical.c #: extmod/ulab/code/numpy/numerical.c
msgid "diff argument must be an ndarray" msgid "diff argument must be an ndarray"
msgstr "" msgstr ""
#: extmod/ulab/code/numpy/numerical/numerical.c #: extmod/ulab/code/numpy/numerical.c
msgid "differentiation order out of range" msgid "differentiation order out of range"
msgstr "" msgstr ""
#: extmod/ulab/code/numpy/transform/transform.c #: extmod/ulab/code/numpy/transform.c
msgid "dimensions do not match" msgid "dimensions do not match"
msgstr "" msgstr ""
@ -3090,7 +3093,7 @@ msgstr ""
msgid "filesystem must provide mount method" msgid "filesystem must provide mount method"
msgstr "" msgstr ""
#: extmod/ulab/code/numpy/vector/vector.c #: extmod/ulab/code/numpy/vector.c
msgid "first argument must be a callable" msgid "first argument must be a callable"
msgstr "" msgstr ""
@ -3102,7 +3105,7 @@ msgstr ""
msgid "first argument must be a tuple of ndarrays" msgid "first argument must be a tuple of ndarrays"
msgstr "" msgstr ""
#: extmod/ulab/code/numpy/vector/vector.c #: extmod/ulab/code/numpy/vector.c
msgid "first argument must be an ndarray" msgid "first argument must be an ndarray"
msgstr "" msgstr ""
@ -3118,7 +3121,7 @@ msgstr ""
msgid "flattening order must be either 'C', or 'F'" msgid "flattening order must be either 'C', or 'F'"
msgstr "" msgstr ""
#: extmod/ulab/code/numpy/numerical/numerical.c #: extmod/ulab/code/numpy/numerical.c
msgid "flip argument must be an ndarray" msgid "flip argument must be an ndarray"
msgstr "" msgstr ""
@ -3246,7 +3249,7 @@ msgstr ""
msgid "index is out of bounds" msgid "index is out of bounds"
msgstr "" msgstr ""
#: extmod/ulab/code/numpy/numerical/numerical.c extmod/ulab/code/ulab_tools.c #: extmod/ulab/code/numpy/numerical.c extmod/ulab/code/ulab_tools.c
#: ports/esp32s2/common-hal/pulseio/PulseIn.c py/obj.c #: ports/esp32s2/common-hal/pulseio/PulseIn.c py/obj.c
#: shared-bindings/bitmaptools/__init__.c #: shared-bindings/bitmaptools/__init__.c
msgid "index out of range" msgid "index out of range"
@ -3288,7 +3291,7 @@ msgstr ""
msgid "input arrays are not compatible" msgid "input arrays are not compatible"
msgstr "" msgstr ""
#: extmod/ulab/code/numpy/poly/poly.c #: extmod/ulab/code/numpy/poly.c
msgid "input data must be an iterable" msgid "input data must be an iterable"
msgstr "" msgstr ""
@ -3321,15 +3324,15 @@ msgstr ""
msgid "input must be square matrix" msgid "input must be square matrix"
msgstr "" msgstr ""
#: extmod/ulab/code/numpy/numerical/numerical.c #: extmod/ulab/code/numpy/numerical.c
msgid "input must be tuple, list, range, or ndarray" msgid "input must be tuple, list, range, or ndarray"
msgstr "" msgstr ""
#: extmod/ulab/code/numpy/poly/poly.c #: extmod/ulab/code/numpy/poly.c
msgid "input vectors must be of equal length" msgid "input vectors must be of equal length"
msgstr "" msgstr ""
#: extmod/ulab/code/numpy/poly/poly.c #: extmod/ulab/code/numpy/poly.c
msgid "inputs are not iterable" msgid "inputs are not iterable"
msgstr "" msgstr ""
@ -3341,7 +3344,7 @@ msgstr ""
msgid "integer required" msgid "integer required"
msgstr "" msgstr ""
#: extmod/ulab/code/numpy/approx/approx.c #: extmod/ulab/code/numpy/approx.c
msgid "interp is defined for 1D iterables of equal length" msgid "interp is defined for 1D iterables of equal length"
msgstr "" msgstr ""
@ -3516,7 +3519,7 @@ msgstr ""
msgid "maxiter should be > 0" msgid "maxiter should be > 0"
msgstr "" msgstr ""
#: extmod/ulab/code/numpy/numerical/numerical.c #: extmod/ulab/code/numpy/numerical.c
msgid "median argument must be an ndarray" msgid "median argument must be an ndarray"
msgstr "" msgstr ""
@ -3533,11 +3536,15 @@ msgstr ""
msgid "memoryview: length is not a multiple of itemsize" msgid "memoryview: length is not a multiple of itemsize"
msgstr "" msgstr ""
#: extmod/ulab/code/numpy/linalg/linalg.c
msgid "mode must be complete, or reduced"
msgstr ""
#: py/builtinimport.c #: py/builtinimport.c
msgid "module not found" msgid "module not found"
msgstr "" msgstr ""
#: extmod/ulab/code/numpy/poly/poly.c #: extmod/ulab/code/numpy/poly.c
msgid "more degrees of freedom than data points" msgid "more degrees of freedom than data points"
msgstr "" msgstr ""
@ -3770,16 +3777,24 @@ msgstr ""
msgid "opcode" msgid "opcode"
msgstr "" msgstr ""
#: extmod/ulab/code/ndarray.c extmod/ulab/code/numpy/compare/compare.c #: extmod/ulab/code/ndarray.c extmod/ulab/code/numpy/compare.c
#: extmod/ulab/code/numpy/vector/vector.c #: extmod/ulab/code/numpy/vector.c
msgid "operands could not be broadcast together" msgid "operands could not be broadcast together"
msgstr "" msgstr ""
#: extmod/ulab/code/numpy/linalg/linalg.c
msgid "operation is defined for 2D arrays only"
msgstr ""
#: extmod/ulab/code/numpy/linalg/linalg.c
msgid "operation is defined for ndarrays only"
msgstr ""
#: extmod/ulab/code/ndarray.c #: extmod/ulab/code/ndarray.c
msgid "operation is implemented for 1D Boolean arrays only" msgid "operation is implemented for 1D Boolean arrays only"
msgstr "" msgstr ""
#: extmod/ulab/code/numpy/numerical/numerical.c #: extmod/ulab/code/numpy/numerical.c
msgid "operation is not implemented on ndarrays" msgid "operation is not implemented on ndarrays"
msgstr "" msgstr ""
@ -3971,7 +3986,7 @@ msgstr ""
msgid "rgb_pins[%d] is not on the same port as clock" msgid "rgb_pins[%d] is not on the same port as clock"
msgstr "" msgstr ""
#: extmod/ulab/code/numpy/numerical/numerical.c #: extmod/ulab/code/numpy/numerical.c
msgid "roll argument must be an ndarray" msgid "roll argument must be an ndarray"
msgstr "" msgstr ""
@ -4050,7 +4065,7 @@ msgstr ""
msgid "soft reboot\n" msgid "soft reboot\n"
msgstr "" msgstr ""
#: extmod/ulab/code/numpy/numerical/numerical.c #: extmod/ulab/code/numpy/numerical.c
msgid "sort argument must be an ndarray" msgid "sort argument must be an ndarray"
msgstr "" msgstr ""
@ -4197,11 +4212,11 @@ msgstr ""
msgid "too many values to unpack (expected %d)" msgid "too many values to unpack (expected %d)"
msgstr "" msgstr ""
#: extmod/ulab/code/numpy/approx/approx.c #: extmod/ulab/code/numpy/approx.c
msgid "trapz is defined for 1D arrays of equal length" msgid "trapz is defined for 1D arrays of equal length"
msgstr "" msgstr ""
#: extmod/ulab/code/numpy/approx/approx.c #: extmod/ulab/code/numpy/approx.c
msgid "trapz is defined for 1D iterables" msgid "trapz is defined for 1D iterables"
msgstr "" msgstr ""
@ -4364,7 +4379,7 @@ msgstr ""
msgid "window must be <= interval" msgid "window must be <= interval"
msgstr "" msgstr ""
#: extmod/ulab/code/numpy/numerical/numerical.c #: extmod/ulab/code/numpy/numerical.c
msgid "wrong axis index" msgid "wrong axis index"
msgstr "" msgstr ""
@ -4372,8 +4387,7 @@ msgstr ""
msgid "wrong axis specified" msgid "wrong axis specified"
msgstr "" msgstr ""
#: extmod/ulab/code/numpy/compare/compare.c #: extmod/ulab/code/numpy/compare.c extmod/ulab/code/numpy/vector.c
#: extmod/ulab/code/numpy/vector/vector.c
msgid "wrong input type" msgid "wrong input type"
msgstr "" msgstr ""
@ -4385,7 +4399,7 @@ msgstr ""
msgid "wrong number of values to unpack" msgid "wrong number of values to unpack"
msgstr "" msgstr ""
#: extmod/ulab/code/numpy/vector/vector.c #: extmod/ulab/code/numpy/vector.c
msgid "wrong output type" msgid "wrong output type"
msgstr "" msgstr ""

10
shared-bindings/_typing/__init__.pyi
View File

@ -10,10 +10,10 @@ import audiocore
import audiomixer import audiomixer
import audiomp3 import audiomp3
import rgbmatrix import rgbmatrix
import ulab import ulab.numpy
ReadableBuffer = Union[ ReadableBuffer = Union[
bytes, bytearray, memoryview, array.array, ulab.ndarray, rgbmatrix.RGBMatrix bytes, bytearray, memoryview, array.array, ulab.numpy.ndarray, rgbmatrix.RGBMatrix
] ]
"""Classes that implement the readable buffer protocol """Classes that implement the readable buffer protocol
@ -21,19 +21,19 @@ ReadableBuffer = Union[
- `bytearray` - `bytearray`
- `memoryview` - `memoryview`
- `array.array` - `array.array`
- `ulab.ndarray` - `ulab.numpy.ndarray`
- `rgbmatrix.RGBMatrix` - `rgbmatrix.RGBMatrix`
""" """
WriteableBuffer = Union[ WriteableBuffer = Union[
bytearray, memoryview, array.array, ulab.ndarray, rgbmatrix.RGBMatrix bytearray, memoryview, array.array, ulab.numpy.ndarray, rgbmatrix.RGBMatrix
] ]
"""Classes that implement the writeable buffer protocol """Classes that implement the writeable buffer protocol
- `bytearray` - `bytearray`
- `memoryview` - `memoryview`
- `array.array` - `array.array`
- `ulab.ndarray` - `ulab.numpy.ndarray`
- `rgbmatrix.RGBMatrix` - `rgbmatrix.RGBMatrix`
""" """

1
tools/extract_pyi.py
View File

@ -39,6 +39,7 @@ IMPORTS_IGNORE = frozenset(
IMPORTS_TYPING = frozenset( IMPORTS_TYPING = frozenset(
{ {
"Any", "Any",
"Dict",
"Optional", "Optional",
"Union", "Union",
"Tuple", "Tuple",