mnets / pymnet

The original library for analyzing multilayer networks.
https://mnets.github.io/pymnet/
GNU General Public License v3.0
118 stars 24 forks source link

[REVIEW] Missing documentation about `pymnet.net.MultilayerNode` #26

Closed ClaudMor closed 3 weeks ago

ClaudMor commented 4 weeks ago

Dear authors,

While running your tutorial, I noticed the existence of the class pymnet.net.MultilayerNode:

from pymnet import *
net = MultilayerNetwork(aspects=0)
net.add_node(1)
net[1]
<pymnet.net.MultilayerNode object at 0x000002CD29CAAA50>

which exists here.

Anyway I could not find documentation for it. Since it exposes public APIs, I'd suggest providing such documentation.

Also, I noticed the use of str to name the function that returns the weighted degree of a node. Since the str name is historically assigned to strings in Python, I would suggest renaming it to something else.

dataspider commented 3 weeks ago

Docs are online here and str has been renamed to strength.