Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Parameter lists hard to parse by eye #111

Closed
dstansby opened this issue Jun 27, 2022 · 5 comments
Closed

Parameter lists hard to parse by eye #111

dstansby opened this issue Jun 27, 2022 · 5 comments
Labels
enhancement New feature or request needs design P2

Comments

@dstansby
Copy link

Parameter lists in napari API docs are hard to parse by eye for me - the black wall of text isn't very good for reading:
Screenshot 2022-06-27 at 13 02 57

It would be good if there could be some distinction between parameter names and values, perhaps using colour? Or putting each parameter on a newline instead of one continuous line?

@neuromusic neuromusic added enhancement New feature or request needs design labels Jun 27, 2022
@jni
Copy link
Member

jni commented Jul 15, 2022

I prefer lines rather than colour. I find the alternating colour of some syntax highlighting very psychedelic and equally hard to read.

Ultimately I think part of the problem is our massive signatures rather than the theme. We can probably group a bunch of them to make this simpler. For example all of the size, face_color etc will go into "style=", all of scale, translate etc into "transforms=", properties (deprecated) will go away... Not discussed but maybe name/metadata, opacity, blending can go into "layer_options=". Then you end up with something a lot more reasonable and readable.

@Czaki
Copy link
Contributor

Czaki commented Jul 15, 2022

Agree, but this refactor should not be only in the constructor but also on the inner Layers structure. They have too many attributes, and they should be grouped.

@jni
Copy link
Member

jni commented Jul 15, 2022

Yes @Czaki, apologies that wasn't clear: the refactor is for the whole stack — it would be very annoying to keep the parameter list and attributes in sync otherwise.

@psobolewskiPhD
Copy link
Member

I think this is much improved with #134
image

What do y'all think?

@jni
Copy link
Member

jni commented Jan 19, 2024

I think we need to simplify our parameter lists 😂

But yes it's so much better 😭 ❤️

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request needs design P2
Projects
None yet
Development

No branches or pull requests

6 participants