Page MenuHome

EnumProperty warning hidden behind scrolling area
Confirmed, NormalPublic

Description

In the documentation of bpy.props.EnumProperty there is an important warning. This is how it is shown by default:

This is what you see when you scroll the parameters area:

Such an important warning should not be hidden.

Event Timeline

Caused by doc/python_api/static/css/theme_overrides.css, fix for T76453: Some args/props in the API docs take *so much* space.

If reverted we get the very long icon lists back (which is arguably acceptable, as hiding information across all docs risks script authors missing important details, where as the long enum lists only impacts the user-interface methods).

Longer term large enum lists could be extracted into their own page which is linked to instead of including inline.

Aaron Carlisle (Blendify) changed the task status from Needs Triage to Confirmed.EditedWed, Mar 31, 7:47 PM
Aaron Carlisle (Blendify) moved this task from Backlog to Python API on the Documentation board.

If we are a bit more restrictive on the CSS selector, I have a solution that seems to work. I need to test it out a bit more to make sure it doesn't cause any regressions else where.

In doc/python_api/static/css/theme_overrides.css change .field-list li { to .field-list dd p {.

Test Page: https://docs.blender.org/api/master/bpy.types.EnumPropertyItem.html

If reverted we get the very long icon lists back (which is arguably acceptable, as hiding information across all docs risks script authors missing important details, where as the long enum lists only impacts the user-interface methods).

Personally I don't care much about the exact solution. If this warning is overlooked it can crash Blender, so it should simply be in a place where people actually see it. If that means taking it out of the parameter list and moving it into the main description of the function, that's fine by me.