One needs a totally new section on User Defined Functions at the same level than Expressions where it should be described the syntax for UDFs. This probably exceeds the scope of this ticket, so it is probably worth filing a new one to be tackled after (or while) this one is addressed.
There are probably more issues that I missed, so please give some love to this (i.e. several cycles of overhauling); the readers will thank you forever :-)
Also the load and open functions should be changed so that they don't accept any config params (neither as Config nor kwargs). This should also be added to the doc.
One needs a new overhaul of the docs (improving docs is a never ending process :-P). Some issues that I have detected:
Enumerated classes in https://ironarray.io/docs/html/reference/config.html needsto be a bit more explicit on what means each class (just
An enumeration
is not enough). For example, for theCodec
enum I suggest to add a link to https://ironarray.io/docs/html/reference/autofiles/config/iarray.Codec.html; and the same goes for others.The link of "See also" section in https://ironarray.io/docs/html/reference/autofiles/config/iarray.set_config.html does not work. (Please do an overhaul of the same "See also" section for other functions too).
In https://ironarray.io/docs/html/reference/autofiles/config/iarray.config.html,
All parameters are the same than in ia.set_config().
should better read:All parameters are the same than in ia.Config().
The description of attributes in https://ironarray.io/docs/html/reference/ndarray.html should all end with a period (
.
).In https://ironarray.io/docs/html/reference/ndarray.html#methods, it is missing the description of
transpose()
. Also, theiter_read_block
anditer_write_block
methods are missing; one should have to document them and add them.In https://ironarray.io/docs/html/reference/autofiles/constructors/iarray.empty.html, the description of
kwargs
should add a link to the https://ironarray.io/docs/html/reference/autofiles/config-class/iarray.Config.html in theConfig dataclass
text. Do the same with all the descriptions ofkwargs
.In https://ironarray.io/docs/html/reference/autofiles/constructors/iarray.empty.html#iarray.empty, the link to
iter_write_block
in See Also section does not work.In https://ironarray.io/docs/html/reference/autofiles/constructors/iarray.ones.html, the return type is not rendered correctly.
In https://ironarray.io/docs/html/reference/linalg.html one should add the recently added
matmul_params()
.In https://ironarray.io/docs/html/reference/autofiles/expressions/iarray.expr_from_string.html, add a "See Also" to
expr_from_udf
, and viceversa.One needs a totally new section on
User Defined Functions
at the same level thanExpressions
where it should be described the syntax for UDFs. This probably exceeds the scope of this ticket, so it is probably worth filing a new one to be tackled after (or while) this one is addressed.There are probably more issues that I missed, so please give some love to this (i.e. several cycles of overhauling); the readers will thank you forever :-)