search

tskit-dev / tskit

Population-scale genomics
MIT License
147 stars 70 forks source link

Mention that node and individual flags are bitwise #2851

Closed szhan closed 9 months ago

szhan commented 9 months ago

When I was accessing nodes_flag, I didn't realise they are bitwise flags. Although it is explained in the documentation of Node Table. This is not explained in the documentation of the property itself. Similarly, it is not explained in the documentation of individuals_flag. Maybe we could just say "Efficient access to the bitwise flags column in the Individual Table as a numpy array (dtype=np.uint32)." in the text?

benjeffery commented 9 months ago

Yeah, good idea. You happy to PR this?

szhan commented 9 months ago

I guess we don't need to explain more than that, right? Just adding bitwise makes it pretty clear, I think.

szhan commented 9 months ago

I just realised that in the docs for Node Table, it doesn't say "bitwise" in the Variables section until the docs for add_rows. Should we also say "bitwise" there?