Skip to content

Mind the gap #1111

@polytypic

Description

@polytypic

So, if I have this in a .mli:

(** Framework for interoperable effects based concurrency.

    ℹ️ Picos, i.e. this module, is not intended to be an application level
    concurrent programming library or framework.  If you are looking for a
    library or framework for programming concurrent applications, then this
    module is probably not what you are looking for.

    {1 Understanding cancelation}

    A central idea of Picos is to provide a collection of building blocks for
    parallelism safe cancelation.  Consider the following characteristic
    example:

The layout will have a (relatively, to my eyes) absolutely massive (some people have said I have a tendency to exaggerate) gap above the first heading (i.e. between preamble and content):

image

I mentioned this in a slack and it was suggested that this gap might be a bug introduced on some redesign of the CSS. In the first couple of screenshots of this PR the screenshots do not have the gap, for example.

At any rate, I don't know whether the gap is intentional design or not, but I do personally find the gap distracting. I'd like to structure the content of documentation with headings without having the gap between the preamble and the content.

Metadata

Metadata

Assignees

No one assigned

    Labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions