search

numba / numba

NumPy aware dynamic Python compiler using LLVM
https://numba.pydata.org/
BSD 2-Clause "Simplified" License
9.92k stars 1.13k forks source link

Add unicode types in the documention #4497

Open luk-f-a opened 5 years ago

luk-f-a commented 5 years ago

Currently the unicode type is not mentioned in section 2.1 of the documentation, making it harder to know what the correct signature is for jitclasses and other places where a type is required.

I am guessing the right place is either 2.1.3.3 or 2.1.4.

stuartarchibald commented 5 years ago

Thanks for the report. Yes, it'd be good to do this, and also to add in more of the types that are not documented. I think with the increasing use of numba.typed containers more users will be making use of the numba.types. Section 2.1.3.3 does indeed seem appropriate.

stuartarchibald commented 5 years ago

xref: https://github.com/numba/numba/issues/3349

esc commented 4 years ago

@stuartarchibald IIRC there was something that addressed this, aye?

stuartarchibald commented 4 years ago

@esc Are you thinking of this http://numba.pydata.org/numba-doc/dev/user/jitclass.html#specifying-numba-typed-containers-as-class-members? In which case, don't think it fixes this ticket.

esc commented 4 years ago

yes, that was what I was thinking about.

luk-f-a commented 4 years ago

@stuartarchibald , if the jitclass section is the right place, I can add a few examples there. I just didn't want to end up duplicating the "types and signatures" section in case you'd prefer to add the content there.