Skip to content

Commit aa18520

Browse files
committed
fix: fix tests (docstring error)
1 parent 9af384f commit aa18520

File tree

1 file changed

+6
-6
lines changed

1 file changed

+6
-6
lines changed

GraphNeuralNetworks/src/samplers.jl

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -14,13 +14,13 @@ originally introduced in "Inductive Representation Learning on Large Graphs" pap
1414
- `batch_size::Union{Int, Nothing}`: The size of the batch. If not specified, it defaults to the number of `input_nodes`.
1515
1616
# Usage
17-
```julia
18-
loader = NeighborLoader(graph; num_neighbors=[10, 5], input_nodes=[1, 2, 3], num_layers=2)
17+
```jldoctest
18+
julia> loader = NeighborLoader(graph; num_neighbors=[10, 5], input_nodes=[1, 2, 3], num_layers=2)
1919
20-
batch_counter = 0
21-
for mini_batch_gnn in loader
22-
batch_counter += 1
23-
println("Batch $batch_counter: Nodes in mini-batch graph: $(nv(mini_batch_gnn))")
20+
julia> batch_counter = 0
21+
julia> for mini_batch_gnn in loader
22+
batch_counter += 1
23+
println("Batch ", batch_counter, ": Nodes in mini-batch graph: ", nv(mini_batch_gnn))
2424
```
2525
"""
2626
struct NeighborLoader

0 commit comments

Comments
 (0)