Skip to content

Commit

Permalink
docs cosmetics
Browse files Browse the repository at this point in the history
  • Loading branch information
fstwn committed May 20, 2020
1 parent c1f4fa2 commit f2bfef7
Show file tree
Hide file tree
Showing 2 changed files with 9 additions and 5 deletions.
7 changes: 5 additions & 2 deletions modules/Cockatoo/KnitDiNetwork.py
Original file line number Diff line number Diff line change
Expand Up @@ -720,7 +720,9 @@ def VerifyDualForm(self):
Returns
-------
True on success, False otherwise.
bool
``True`` on success.
``False`` otherwise.
"""

# check every single node
Expand Down Expand Up @@ -754,7 +756,8 @@ def MakeCsvData(self):
Returns
-------
CSV Data : List of lists (rows) where every value represents a node
CSV Data
List of lists (rows) where every value represents a node
"""
pass

Expand Down
7 changes: 4 additions & 3 deletions modules/Cockatoo/KnitNetwork.py
Original file line number Diff line number Diff line change
Expand Up @@ -290,8 +290,9 @@ def AttemptWeftConnectionToCandidate(self, node, candidate, source_nodes, max_co
Returns
-------
result : bool
True if the connection has been made, otherwise false.
bool
``True`` if the connection has been made.
``False`` otherwise.
"""

# define verbose print function
Expand Down Expand Up @@ -2534,7 +2535,7 @@ def CreateDual(self, mode=-1):
Returns
-------
Dual : KnitNetwork
Dual : KnitDiNetwork
The dual network of this KnitNetwork.
Warning
Expand Down

0 comments on commit f2bfef7

Please sign in to comment.