Skip to content

HTML backend: refine specification rendering#615

Merged
jonludlam merged 8 commits intoocaml:masterfrom
dbuenzli:documentedsrc-kind
Mar 11, 2021
Merged

HTML backend: refine specification rendering#615
jonludlam merged 8 commits intoocaml:masterfrom
dbuenzli:documentedsrc-kind

Conversation

@dbuenzli
Copy link
Copy Markdown
Contributor

@dbuenzli dbuenzli commented Feb 28, 2021

This PR is built on top of #612, the relevant commits start at e7d6fd3

It does the following:

@dbuenzli
Copy link
Copy Markdown
Contributor Author

While doing this PR I realized the rendering by the default stylesheet of variants with a doc string is not very nice, I just want to stress that this is not a side effect of this PR. I don't think it's worth fixing before #614 is.

Copy link
Copy Markdown
Contributor

@Drup Drup left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm generally in favor of these changes, except for the copy-paste one. Your solution is, imho, not acceptable, but I'm pretty sure we can do better. The rest is good to go (as soon as the previous PRs are merged).

@dbuenzli dbuenzli force-pushed the documentedsrc-kind branch from ae78979 to db135b3 Compare March 10, 2021 20:07
We simply use the `attr` pattern already present in
the IR model.

This also slightly tweaks some of the "kinds":

* `extension` becomes `type extension`
* `type-subst` becomes `type subst`
* `external` becomes `value external`
* `instance-variable` becomes `value instance-variable`

Fixes part of ocaml#601.
@dbuenzli dbuenzli force-pushed the documentedsrc-kind branch from db135b3 to b716452 Compare March 11, 2021 07:40
@dbuenzli
Copy link
Copy Markdown
Contributor Author

I'm generally in favor of these changes, except for the copy-paste one.

This has been removed.

In any case I didn't review these classifications, but they should certainly be.

I suggest we do that in a separate PR once #630 has been resolved.


The PR has been rebased

@jonludlam jonludlam merged commit 78cb928 into ocaml:master Mar 11, 2021
@jonludlam
Copy link
Copy Markdown
Member

Thanks!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Record field and variant case rendering breaks cut and paste

3 participants