Skip to content

Conversation

@OkonSamuel
Copy link
Contributor

closes #36878

@StefanKarpinski
Copy link
Member

Does this fix it? I would think that adding a line here would not help attach the warning to the text.

@OkonSamuel
Copy link
Contributor Author

OkonSamuel commented Aug 2, 2020

Does this fix it? I would think that adding a line here would not help attach the warning to the text.

Yes. It does. I faced something similar when generating https://github.com/cstjean/ScikitLearn.jl/edit/master/docs/src/man/models.md.
You can also confirm this by comparing https://github.com/JuliaLang/julia/blob/master/doc/src/manual/types.md#primitive-types with https://github.com/OkonSamuel/julia/blob/master/doc/src/manual/types.md#primitive-types.
The github diffs don't show the difference clearly. You have to open the two links to see.

@StefanKarpinski
Copy link
Member

@mortenpi, is this a Documenter bug? I'm a bit confused by what the right way to format/fix this is.

@mortenpi
Copy link
Contributor

mortenpi commented Aug 2, 2020

No, it's an indentation problem on the 1.5 branch. It's already fixed on master: https://docs.julialang.org/en/v1.6-dev/manual/types/#Primitive-Types-1

The correct fix would be to backport #36254 to 1.5.

For what it's worth, as a style matter, I personally prefer having an empty line between the !!! line and the admonition body, so we could merge this, even if it doesn't actually do anything for #36878.

@fredrikekre fredrikekre closed this Aug 3, 2020
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.

incorrect formatting on primitive types section, first warning label

4 participants