microbit-foundation / python-editor-v3

Micro:bit Educational Foundation Python Editor V3
https://python.microbit.org
MIT License
57 stars 36 forks source link

Misunderstanding or bug in collapsed docs #981

Closed kmcnaught closed 2 years ago

kmcnaught commented 2 years ago

Bug Description

I have had some users complain that the collapsed description in the docs is not helpful as it is often cut off with an ellipsis after half a sentence. I've noticed that the full sentence is actually present in the DOM and it's just being wrapped visually. Is this intentional?

As an example, see Variables -> Changing number variables.

The original state is this, with an ellipsis cutting off mid sentence:

screenshot of collapsed text

From this state, although you can't see it, you can select the whole text "Set variables to their initial values at the start of a program using the = sign:" or have it all read out by a screen reader.

The expanded state is this:

screenshot of expanded text

It feels like perhaps the intended behaviour was to include the following in the collapsed version:

screenshot of expanded text

Not sure if this is a bug report just user feedback? It came up in a couple of different accessibility contexts:

microbit-matt-hillsdon commented 2 years ago

The behaviour here is as designed. We spent quite a lot of time discussing the amount of information visible by default and ended up prioritising being able to get an overview of what was there (minimising need to scroll), before interacting with what we think is likely to be one or two items from each section. We'll collect feedback on this over time and might reconsider in future. Closing for now.