Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Mind the gap #1111

Open
polytypic opened this issue Apr 16, 2024 · 0 comments
Open

Mind the gap #1111

polytypic opened this issue Apr 16, 2024 · 0 comments
Labels
good-first-issue Good for newcomers

Comments

@polytypic
Copy link

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.

@panglesd panglesd added the good-first-issue Good for newcomers label May 15, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
good-first-issue Good for newcomers
Projects
None yet
Development

No branches or pull requests

2 participants