search

napari / docs

Documentation for napari (other than API docs)
BSD 3-Clause "New" or "Revised" License
10 stars 37 forks source link

[API docs] Explain that face_color_cycle accepts dictionary #245

Open ziyuanzhao2000 opened 11 months ago

ziyuanzhao2000 commented 11 months ago

From the merge described at the bottom of this issue, I learned that we can now specify the precise feature value to color mapping for point layers by passing a dictionary to the face_color_cycle argument. This is very essential for my project.

However, the documentation is outdated and on this page the input type doesn't include dictionary type.

I'm pretty sure many users will find it very useful to specify this color mapping rather than just arbitrarily assign color from the color cycle, so we should make it clear in the documentation that this feature actually exists already. Thank you very much!

psobolewskiPhD commented 11 months ago

Indeed it appears that https://github.com/napari/napari/pull/1623 added support for dicts. The API docs are auto-generated from the doc strings, so this needs to be fixed in the napari repo. FYI, this means that if you're looking for dev docs, you need to use the version switcher and select latest.

Separately there is on-going work to improve the documentation of properties (which will soon be deprecated) and features. See: https://napari.zulipchat.com/#narrow/stream/298358-working-group-documentation/topic/meeting.202023-09-26/near/393562552 for the latest.

ziyuanzhao2000 commented 11 months ago

Thank you, this makes a lot of sense! By the way, I'm happy to help improve the documentation or tutorials. I've been using Napari to visualize pathology images and found the tool very powerful and customizable, although we can certainly do better with some areas in the current documentation.