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

Improve documentation using packages in doctests for display #1564

Closed
bkamins opened this issue Apr 10, 2021 · 1 comment
Closed

Improve documentation using packages in doctests for display #1564

bkamins opened this issue Apr 10, 2021 · 1 comment

Comments

@bkamins
Copy link
Contributor

bkamins commented Apr 10, 2021

Recently in DataFrames.jl we had the following issue with running doctests JuliaData/DataFrames.jl#2705.

The problem was that the Documenter.jl documentation uses what was actually used in make.jl to format display not what is used in the doctests.

So e.g. the following code:

using CategoricalArrays
categorical(["a"])

produces the following array signature:

CategoricalArrays.CategoricalArray{String,1,UInt32}

instead of correct:

CategoricalArray{String,1,UInt32}

The issue is resolved by adding using CategoricalArrays also to make.jl.

I could not find any documentation that for producing display what is used in make.jl is respected (and not what you use in the actual doctest).

Maybe it is documented then sorry for raising this issue and it can be closed. However, I could not find this information.

@fredrikekre
Copy link
Member

This is just a quirk in Julia's display system where names are not displayed fully qualified if they are available in Main. Closing as a duplicate of #944.

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

No branches or pull requests

3 participants