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

Fix css of layout for datatypes #847

Merged
merged 1 commit into from
Jun 8, 2022

Conversation

panglesd
Copy link
Collaborator

This PR fixes the css introduced in #830:

It find it more logical that odoc comments always have a --main-background color, even if they are inside a spec (with background --spec-summary-background).

I think it makes it easier to read large record fields with many comments attached to fields.

Compare the two images:
image
with
image

You can find complete examples of the old style and new style for this file.

(Maybe the thin blue bar could be removed now that the background is white... what do you think?)

Copy link
Collaborator

@Julow Julow left a comment

Choose a reason for hiding this comment

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

That's better !

But I find it ugly to have both the blue border and the shadow, let's remove the border.

@@ -451,11 +451,13 @@ div.odoc-spec,.odoc-include {

.spec.type .record > .def-doc, .spec.type .variant > .def-doc {
min-width:50%;
padding-left: 22px;
padding-left: 18px;
Copy link
Collaborator

Choose a reason for hiding this comment

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

If you remove the blue border, a smaller padding would be better: (the same as .spec)

Suggested change
padding-left: 18px;
padding: 0.35em 0.5em;

Signed-off-by: Paul-Elliot <peada@free.fr>
Copy link
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 agree, this is much better. 👍

@leviroth
Copy link

Could the doc comments be consistently placed below the constructor? I find it awkward to read when some of the comments are below and some of them are off to the right.

@jonludlam
Copy link
Member

Thanks @panglesd!

@leviroth Perhaps! I'm always happy to look at any style fixes. For now, I'll merge this as it's already a big improvement.

@jonludlam jonludlam merged commit b7a9828 into ocaml:master Jun 8, 2022
mseri pushed a commit to ocaml/opam-repository that referenced this pull request Dec 13, 2022
CHANGES:

Additions
- New unstable option `--as-json` for the HTML renderer that emits HTML
  fragments (preamble, content) together with metadata (table of contents,
  breadcrumbs, whether katex is used) in JSON format. (@sabine, ocaml/odoc#908)
- New maths support via `{m ... }` and `{math ... }` tags. (@giltho, @gpetiot, ocaml/odoc#886)
- Various optimisations (@jonludlam, ocaml/odoc#870, ocaml/odoc#883)
- Better handling of alerts and deprecation notices. (@panglesd, ocaml/odoc#828)
- Handle language tags on code blocks (@Julow, ocaml/odoc#848)

Bugfixes
- Shadowing issues (@jonludlam, ocaml/odoc#853)
- Layout fixes and improvements (@panglesd, ocaml/odoc#832, ocaml/odoc#839, ocaml/odoc#847)
- Handle comments on class constraints and inherit (@Julow, ocaml/odoc#844)
- Disable the missing root warning (@jonludlam, ocaml/odoc#881)
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.

None yet

5 participants