JuliaFormatter, JuliaHub docs, and the public keyword

[scheinerman]

I have found that tagging some of my functions as public causes two problems. First, JuliaFormatter fails. Second, the documentation I built with Documenter doesn’t migrate to docs.juliahub.com.

[mbauman]

Ah, yes, I think JuliaHub is currently building all its docs using v1.10. If you want to use public, you should set Julia’s compat to “1.11” in your project or use one of the compat-ified equivalents:

Is Compat.jl worth it for the `public` keyword?

With the introduction of public by @Lilith, many packages will want to mark their unexported public symbols that way. Since public is only available in Julia 1.11, the current recommended way to do this in 1.10 is with the Compat.jl package. Before we add it everywhere, I’m wondering if there are any negative side effects to it? @stevengj seems to think it’s fine but I’d love to get other opinions. In particular, it depends on 4 stdlibs: Dates, LinearAlgebra, TOML and UUIDs.

[Eben60]

@mbauman

should set Julia’s compat to “1.11” in your project

As an additional information: I’ve set the Julia’s compat to “1.10” for the package itself (ShareAdd.jl), and “1.11” for the Project.toml in the docs subfolder. Unfortunately, Documenter-built documentation does not appear on the juliahub.com

[mbauman]

Yeah, sorry, I should’ve been clearer — my second sentence doesn’t (yet!) affect JuliaHub’s behavior here. You can see the build logs by clicking the little \enclose{circle}{\text{i}} button:

You’ll see that there’s a message in there warning that julia version requirement for project not satisfied.

[j-fu]

You can reroute Juliahub’s documentation link, see

GitHub - JuliaDocs/DocumentationGeneratorRegistry

[Eben60]

@mbauman

(yet!)

any estimation of the timeframe?