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

Bad rendering of DefaultDict doc #436

Closed
scls19fr opened this issue Aug 16, 2018 · 15 comments
Closed

Bad rendering of DefaultDict doc #436

scls19fr opened this issue Aug 16, 2018 · 15 comments

Comments

@scls19fr
Copy link
Member

scls19fr commented Aug 16, 2018

Hello,

I shouldn't have merge #431 !
Sorry about that!

With lastest master version of Documenter we are still facing bad rendering

julia> dd = DefaultDict{AbstractString, Vector{Int}}(Vector{Int})
DefaultDict{AbstractString,Array{Int64,1},DataType} with 0 entries

┌ Warning: Deprecated syntax `underscores as an rvalue`.
└ @ none:0

julia> push!(dd["A"], 1)
1-element Array{Int64,1}:
 1

┌ Warning: Deprecated syntax `underscores as an rvalue`.
└ @ none:0

Pinging @fredrikekre @mortenpi from

Kind regards

@scls19fr
Copy link
Member Author

That's just warnings... we can live with that but without warnings, doc looks better

@mortenpi
Copy link
Contributor

FWIW, I can't replicate this (I don't see it in the hosted docs, nor when I build locally).

@fredrikekre
Copy link
Member

Start julia with julia --depwarn=error and you will get a tracktrace to the warning.

@scls19fr
Copy link
Member Author

There is still warnings on my local build of doc file:///home/scls/.julia/dev/DataStructures/docs/build/default_dict.html
About hosted doc... problem is #430
About using julia --depwarn=error we first need to tackle #433

@scls19fr
Copy link
Member Author

http://juliacollections.github.io/DataStructures.jl/latest/default_dict.html

We are still seeing

┌ Warning: Deprecated syntax `underscores as an rvalue`.
└ @ none:0

https://github.com/JuliaCollections/DataStructures.jl/tree/gh-pages was updated 2 minutes ago...

So there is still an issue with that

@fredrikekre
Copy link
Member

Seems to only happen on Travis then.

@scls19fr
Copy link
Member Author

That's odd because I don't see it now on my local build. But you are right we are still seeing this on Travis!

@fredrikekre
Copy link
Member

Can you try changing julia = "0.7" to julia = "1.0" in docs/make.jl?

@mortenpi
Copy link
Contributor

I was now able to get it to replicate on my machine, but only on 0.7.0. Interestingly, depawn = error does not make the build fail and the depwarns disappear.

@fredrikekre
Copy link
Member

So just build the docs on 1.0 where deprecations are removed then 😛

@scls19fr
Copy link
Member Author

#430 is reappearing...
https://github.com/JuliaCollections/DataStructures.jl/tree/gh-pages (only updated 2 hours ago)
maybe I should add 1.0 to .travis.yml also (nightly is not enough)

@mortenpi
Copy link
Contributor

So this appears to be a potential bug in Documenter. To work around it, but still deploy on 0.7, you can remove the empty lines in at-repl blocks. The warnings come from those.

@scls19fr
Copy link
Member Author

That's not a big problem for now.
I will keep it like that. Could you open an issue on Documenter.jl
and ping me when you find a fix ?
So we could test that here

@mortenpi
Copy link
Contributor

maybe I should add 1.0 to .travis.yml also (nightly is not enough)

Yes. Also make sure that all your scripts support 1.0.. there is a "Pkg missing" error on the nightly. The Travis logs generally have all the logs that help debugging such problems.

when you find a fix ?

Not 100% this will happen. This might be a weird 0.7-only thing (e.g. some interaction with how deprecations are implemented).

@laborg
Copy link
Collaborator

laborg commented Oct 4, 2023

The bug was closed on Documenter.

@laborg laborg closed this as completed Oct 4, 2023
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

No branches or pull requests

4 participants