Skip to content

Commit a60102b

Browse files
InterdisciplinaryPhysicsTeamClaudMorpitmonticone
committed
Clean docstrings
Co-Authored-By: Claudio Moroni <43729990+ClaudMor@users.noreply.github.com> Co-Authored-By: Pietro Monticone <38562595+pitmonticone@users.noreply.github.com>
1 parent e73ed74 commit a60102b

File tree

3 files changed

+7
-3
lines changed

3 files changed

+7
-3
lines changed

.vscode/settings.json

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,14 @@
11
{
22
"cSpell.words": [
3+
"abstractmatrixrrepresentation",
34
"abstractmultilayerdigraph",
45
"abstractmultilayergraph",
56
"abstractmultilayerugraph",
67
"abstractmultiplexdigraph",
78
"abstractmultiplexugraph",
89
"abstractsubgraph",
10+
"abstracttensorrepresentation",
11+
"abstractvertex",
912
"add_vertex",
1013
"adjm",
1114
"agrs",
@@ -107,6 +110,7 @@
107110
"supraweightmatrix",
108111
"swdg",
109112
"tensoreig",
113+
"tensorfacoriazations",
110114
"tensorsfactorizations",
111115
"testset",
112116
"traitdef",

docs/src/index.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -71,15 +71,15 @@ const max_vertices = 7
7171
const n_nodes = max_vertices
7272
```
7373

74-
Next we define the list of immutable objects that are represneted (through vertices, see below) in the various layers and interlayers of a multilayer graph. These obkects are called [`Node`](@ref)s. The constructor for a `Node` reads:
74+
Next we define the list of immutable objects that are represented (through vertices, see below) in the various layers and interlayers of a multilayer graph. These objects are called [`Node`](@ref)s. The constructor for a `Node` reads:
7575

7676
```julia
7777
Node(
7878
id::String
7979
)
8080
```
8181

82-
Where `id` is a `String` that is the name of what the `Node` stands for (could be cities in a transportation network, users in a social network, etc.). Let's contruct a list of `Node`s to use in the remainder of the tutorial:
82+
Where `id` is a `String` that is the name of what the `Node` stands for (could be cities in a transportation network, users in a social network, etc.). Let's construct a list of `Node`s to use in the remainder of the tutorial:
8383

8484
```julia
8585
# The constructor for nodes (which are immutable) only requires a name (`id`) for the node

src/abstractmultilayergraph.jl

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -295,7 +295,7 @@ function get_metadata(
295295
end
296296

297297
"""
298-
get_weight(mg::AbstractMultilayerGraph, src::MultilayerVertex, dst::MultilayerVertexph
298+
get_weight(mg::AbstractMultilayerGraph, src::MultilayerVertex, dst::MultilayerVertex)h
299299
300300
Return the weight associated to the `MultilayerEdge` from `src` to `dst`.
301301
"""

0 commit comments

Comments
 (0)