Skip to content

Misunderstanding or bug in collapsed docs #981

@kmcnaught

Description

@kmcnaught

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:

  • user with motor disability having to do an extra click for every topic (since half a sentence is rarely sufficient)
  • user with adhd/cognitive processing difficulties having too much extra information appear when they just needed the end of the first sentence

Metadata

Metadata

Assignees

No one assigned

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions