Skip to content
This repository was archived by the owner on Aug 3, 2024. It is now read-only.
This repository was archived by the owner on Aug 3, 2024. It is now read-only.

Make collapsible sections more visible #699

@Lysxia

Description

@Lysxia

Some libraries, such as base, use these sections to show examples, but those are surprisingly discreet to the point that one might not even see it. Part of the fault lies in haddock users who arguably abuse this feature rather than the tool itself, but there are still ways for haddock to adapt.

  • In my experience, these sections have always contained information that would be extremely helpful to the largest number of newcomers, so they should be expanded by default.

  • A single switch to collapse/expand everything would be nice too.

  • One cause of this visibiility problem may also be that only the box in "⊞ Examples", which occupies a very small area, gives an indication that the header is clickable at all. Perhaps adding a background color or some kind of border to these sections would be a stronger hint.

    Compare:
    sc-2017-11-10t08 48 01-05 00
    sc-2017-11-10t08 57 08-05 00

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions