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.

Sign up for GitHub

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

Jump to bottom

Update for Documenter.jl v1 and Julia v1.10 #3416

Merged
merged 5 commits into from
Jan 19, 2024
Merged

Update for Documenter.jl v1 and Julia v1.10 #3416

Show file tree
Hide file tree
Changes from 3 commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
e61d32e
update the Documenter compat
hyrodium Jan 10, 2024
9dd83d5
update docs/make.jl for Documenter v1
hyrodium Jan 10, 2024
ba80907
update jldoctest for Julia v1.10
hyrodium Jan 10, 2024
66e6e26
add julia compat for docs/Project.toml
hyrodium Jan 10, 2024
86d2eac
Try removing julia compat in docs/Project.toml and check v1.10 will b…
hyrodium Jan 16, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion docs/Project.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,4 +11,4 @@ Statistics = "10745b16-79ce-11e8-11f9-7d13ad32a3b2"
Tables = "bd369af6-aec1-5ad0-b16a-f7cc5008161c"

[compat]
Documenter = "0.27"
Documenter = "1"
8 changes: 4 additions & 4 deletions docs/make.jl
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,8 @@ makedocs(
format = Documenter.HTML(
canonical = "https://juliadata.github.io/DataFrames.jl/stable/",
assets = ["assets/favicon.ico"],
edit_link = "main"
edit_link = "main",
size_threshold_ignore = ["man/basics.md", "lib/functions.md"],
bkamins marked this conversation as resolved.
Show resolved Hide resolved
),
pages = Any[
"Introduction" => "index.md",
Expand All @@ -42,11 +43,10 @@ makedocs(
hide("Internals" => "lib/internals.md"),
]
],
strict = true
)

# Deploy built documentation from Travis.
# =======================================
# Deploy built documentation.
# ===========================

deploydocs(
# options
Expand Down
4 changes: 2 additions & 2 deletions docs/src/man/getting_started.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -441,9 +441,9 @@
A particular common case of a collection that supports the
[Tables.jl](https://github.com/JuliaData/Tables.jl) interface is
a vector of `NamedTuple`s:
```jldoctest dataframe

Check failure on line 444 in docs/src/man/getting_started.md

View workflow job for this annotation

GitHub Actions / Documentation 

doctest failure in src/man/getting_started.md:444-457

```jldoctest dataframe
julia> v = [(a=1, b=2), (a=3, b=4)]
2-element Vector{@NamedTuple{a::Int64, b::Int64}}:
 (a = 1, b = 2)
 (a = 3, b = 4)

julia> df = DataFrame(v)
2×2 DataFrame
 Row │ a      b
     │ Int64  Int64
─────┼──────────────
   1 │     1      2
   2 │     3      4
```

Subexpression:

v = [(a=1, b=2), (a=3, b=4)]

Evaluated output:

2-element Vector{NamedTuple{(:a, :b), Tuple{Int64, Int64}}}:
 (a = 1, b = 2)
 (a = 3, b = 4)

Expected output:

2-element Vector{@NamedTuple{a::Int64, b::Int64}}:
 (a = 1, b = 2)
 (a = 3, b = 4)


  diff = 
    Warning: Diff output requires color.
    2-element Vector{@NamedTuple{a::Int64, b::Int64}}:
     Vector{NamedTuple{(:a, :b), Tuple{Int64, Int64}}}:
     (a = 1, b = 2)
     (a = 3, b = 4)
julia> v = [(a=1, b=2), (a=3, b=4)]
2-element Vector{NamedTuple{(:a, :b), Tuple{Int64, Int64}}}:
2-element Vector{@NamedTuple{a::Int64, b::Int64}}:
(a = 1, b = 2)
(a = 3, b = 4)

Expand All @@ -456,11 +456,11 @@
2 │ 3 4
```
You can also easily convert a data frame back to a vector of `NamedTuple`s:
```jldoctest dataframe

Check failure on line 459 in docs/src/man/getting_started.md

View workflow job for this annotation

GitHub Actions / Documentation 

doctest failure in src/man/getting_started.md:459-466

```jldoctest dataframe
julia> using Tables

julia> Tables.rowtable(df)
2-element Vector{@NamedTuple{a::Int64, b::Int64}}:
 (a = 1, b = 2)
 (a = 3, b = 4)
```

Subexpression:

Tables.rowtable(df)

Evaluated output:

2-element Vector{NamedTuple{(:a, :b), Tuple{Int64, Int64}}}:
 (a = 1, b = 2)
 (a = 3, b = 4)

Expected output:

2-element Vector{@NamedTuple{a::Int64, b::Int64}}:
 (a = 1, b = 2)
 (a = 3, b = 4)


  diff = 
    Warning: Diff output requires color.
    2-element Vector{@NamedTuple{a::Int64, b::Int64}}:
     Vector{NamedTuple{(:a, :b), Tuple{Int64, Int64}}}:
     (a = 1, b = 2)
     (a = 3, b = 4)
julia> using Tables

julia> Tables.rowtable(df)
2-element Vector{NamedTuple{(:a, :b), Tuple{Int64, Int64}}}:
2-element Vector{@NamedTuple{a::Int64, b::Int64}}:
(a = 1, b = 2)
(a = 3, b = 4)
```
2 changes: 1 addition & 1 deletion src/abstractdataframe/iteration.jl
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@
but also passes information on the `eltypes` of the columns of `df`.

# Examples
```jldoctest

Check failure on line 38 in src/abstractdataframe/iteration.jl

View workflow job for this annotation

GitHub Actions / Documentation 

doctest failure in ~/work/DataFrames.jl/DataFrames.jl/src/abstractdataframe/iteration.jl:38-73

```jldoctest
julia> df = DataFrame(x=1:4, y=11:14)
4×2 DataFrame
 Row │ x      y
     │ Int64  Int64
─────┼──────────────
   1 │     1     11
   2 │     2     12
   3 │     3     13
   4 │     4     14

julia> eachrow(df)
4×2 DataFrameRows
 Row │ x      y
     │ Int64  Int64
─────┼──────────────
   1 │     1     11
   2 │     2     12
   3 │     3     13
   4 │     4     14

julia> copy.(eachrow(df))
4-element Vector{@NamedTuple{x::Int64, y::Int64}}:
 (x = 1, y = 11)
 (x = 2, y = 12)
 (x = 3, y = 13)
 (x = 4, y = 14)

julia> eachrow(view(df, [4, 3], [2, 1]))
2×2 DataFrameRows
 Row │ y      x
     │ Int64  Int64
─────┼──────────────
   1 │    14      4
   2 │    13      3
```

Subexpression:

copy.(eachrow(df))

Evaluated output:

4-element Vector{NamedTuple{(:x, :y), Tuple{Int64, Int64}}}:
 (x = 1, y = 11)
 (x = 2, y = 12)
 (x = 3, y = 13)
 (x = 4, y = 14)

Expected output:

4-element Vector{@NamedTuple{x::Int64, y::Int64}}:
 (x = 1, y = 11)
 (x = 2, y = 12)
 (x = 3, y = 13)
 (x = 4, y = 14)


  diff = 
    Warning: Diff output requires color.
    4-element Vector{@NamedTuple{x::Int64, y::Int64}}:
     Vector{NamedTuple{(:x, :y), Tuple{Int64, Int64}}}:
     (x = 1, y = 11)
     (x = 2, y = 12)
     (x = 3, y = 13)
     (x = 4, y = 14)
julia> df = DataFrame(x=1:4, y=11:14)
4×2 DataFrame
Row │ x y
Expand All @@ -57,7 +57,7 @@
4 │ 4 14

julia> copy.(eachrow(df))
4-element Vector{NamedTuple{(:x, :y), Tuple{Int64, Int64}}}:
4-element Vector{@NamedTuple{x::Int64, y::Int64}}:
(x = 1, y = 11)
(x = 2, y = 12)
(x = 3, y = 13)
Expand Down
Loading