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

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

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

View File

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

View File

@ -10,10 +10,10 @@ import audiocore
import audiomixer
import audiomp3
import rgbmatrix
import ulab
import ulab.numpy
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
@ -21,19 +21,19 @@ ReadableBuffer = Union[
- `bytearray`
- `memoryview`
- `array.array`
- `ulab.ndarray`
- `ulab.numpy.ndarray`
- `rgbmatrix.RGBMatrix`
"""
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
- `bytearray`
- `memoryview`
- `array.array`
- `ulab.ndarray`
- `ulab.numpy.ndarray`
- `rgbmatrix.RGBMatrix`
"""

View File

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