Skip to content

Commit

Permalink
Fix docstrings
Browse files Browse the repository at this point in the history
  • Loading branch information
aurorarossi committed Sep 20, 2024
1 parent 8ab1db0 commit 987bf8d
Show file tree
Hide file tree
Showing 5 changed files with 8 additions and 8 deletions.
2 changes: 1 addition & 1 deletion GNNGraphs/src/gnngraph.jl
Original file line number Diff line number Diff line change
Expand Up @@ -66,7 +66,7 @@ functionality from that library.
# Examples
```julia
using GraphNeuralNetworks
using GNNGraphs, Graphs
# Construct from adjacency list representation
data = [[2,3], [1,4,5], [1], [2,5], [2,4]]
Expand Down
2 changes: 1 addition & 1 deletion GNNGraphs/src/gnnheterograph.jl
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@ It is similar to [`GNNGraph`](@ref) but nodes and edges are of different types.
# Examples
```julia
julia> using GraphNeuralNetworks
julia> using GNNGraphs
julia> nA, nB = 10, 20;
Expand Down
2 changes: 1 addition & 1 deletion GNNGraphs/src/mldatasets.jl
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ Convert a graph dataset from the package MLDatasets.jl into one or many [`GNNGra
# Examples
```julia
julia> using MLDatasets, GraphNeuralNetworks
julia> using MLDatasets, GNNGraphs
julia> mldataset2gnngraph(Cora())
GNNGraph:
Expand Down
6 changes: 3 additions & 3 deletions GNNGraphs/src/temporalsnapshotsgnngraph.jl
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ The features can be passed at construction time or added later.
# Examples
```julia
julia> using GraphNeuralNetworks
julia> using GNNGraphs
julia> snapshots = [rand_graph(10,20) for i in 1:5];
Expand Down Expand Up @@ -78,7 +78,7 @@ Return a `TemporalSnapshotsGNNGraph` created starting from `tg` by adding the sn
# Examples
```jldoctest
julia> using GraphNeuralNetworks
julia> using GNNGraphs
julia> snapshots = [rand_graph(10, 20) for i in 1:5];
Expand Down Expand Up @@ -138,7 +138,7 @@ Return a [`TemporalSnapshotsGNNGraph`](@ref) created starting from `tg` by remov
# Examples
```jldoctest
julia> using GraphNeuralNetworks
julia> using GNNGraphs
julia> snapshots = [rand_graph(10,20), rand_graph(10,14), rand_graph(10,22)];
Expand Down
4 changes: 2 additions & 2 deletions GNNGraphs/src/transform.jl
Original file line number Diff line number Diff line change
Expand Up @@ -170,7 +170,7 @@ A new GNNGraph with the specified edges removed.
# Example
```julia
julia> using GraphNeuralNetworks
julia> using GNNGraphs
# Construct a GNNGraph
julia> g = GNNGraph([1, 1, 2, 2, 3], [2, 3, 1, 3, 1])
Expand Down Expand Up @@ -275,7 +275,7 @@ A new GNNGraph with the specified nodes and all edges associated with these node
# Example
```julia
using GraphNeuralNetworks
using GNNGraphs
g = GNNGraph([1, 1, 2, 2, 3], [2, 3, 1, 3, 1])
Expand Down

0 comments on commit 987bf8d

Please sign in to comment.