Skip to content

Commit 86139e1

Browse files
committed
Documentation edits.
1 parent f5fd3e3 commit 86139e1

File tree

1 file changed

+8
-0
lines changed

1 file changed

+8
-0
lines changed

gitnet/log.py

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -740,6 +740,14 @@ def generate_network(self, mode1, mode2, colours=None, edge_helper=net_edges_sim
740740
741741
>> The tag string for the second mode type.
742742
743+
> *colours* : `string`
744+
745+
>> The string that specifies the colour preset desired by the user.
746+
>> *Simple* : Returns a graph in which each mode is a different colour (red and white). Attention to the order of modes is required, as there is no table.
747+
>> *Complex* : Returns a graph in which each mode is a different colour, and if `files` is one of the modes, popular file types will be a different colour.
748+
>> Otherwise, simply do not include the colour argument. The defualt colour is light grey for all nodes.
749+
>> Enabling colours will also add the colours column to the node data, which will allow importing into other software. See the walkthrough and R tutorial for the example.
750+
743751
> *edge_helper* : `None`
744752
745753
>> The helper function used to compute an edge.

0 commit comments

Comments
 (0)