Skip to content

Commit b1cf2f3

Browse files
committed
Tweak some docs
1 parent 82a7adf commit b1cf2f3

File tree

2 files changed

+12
-1
lines changed

2 files changed

+12
-1
lines changed

pymathics/graph/base.py

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -87,6 +87,17 @@ def graph_helper(
8787
*args,
8888
**kwargs,
8989
) -> Optional["Graph"]:
90+
"""
91+
This is a wrapping function for a NetworkX function of some sort indicated in ``graph_generator``,
92+
e.g. ``nx.complete_graph``.
93+
94+
``args`` and ``kwargs`` are passed to the NetworkX function, while ``can_digraph`` determines
95+
whether ``create_using=nx.DiGraph``is added to the NetworkX graph-generation function call.
96+
97+
Parameter ``options`` and ``graph_layout`` are Mathics3 Graph
98+
options; ``graph_layout`` has a ``String()`` wrapped around it
99+
``root`` is used when the graph is a tree.
100+
"""
90101
should_digraph = can_digraph and has_directed_option(options)
91102
try:
92103
G = (

pymathics/graph/eval/parametric.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -36,7 +36,7 @@ def eval_full_rary_tree(
3636
self, r: Integer, n: Integer, expression, evaluation: Evaluation, options: dict
3737
) -> Optional[Graph]:
3838
"""
39-
Call networkx to get a full_rary_tree using parameters, ``r`` and ``t``.
39+
Call ``networkx.full_rary_tree()`` using parameters, ``r`` and ``t``.
4040
"""
4141
py_r = r.value
4242

0 commit comments

Comments
 (0)