Skip to content

Commit

Permalink
Tidy up docstring
Browse files Browse the repository at this point in the history
  • Loading branch information
MrCurtis committed Jan 29, 2024
1 parent 8a2d652 commit 373d0bf
Showing 1 changed file with 7 additions and 1 deletion.
8 changes: 7 additions & 1 deletion src/fk_graph/graph.py
Original file line number Diff line number Diff line change
Expand Up @@ -67,7 +67,13 @@ def get_graph(
primary_key: The primary key for the row.
only_tables: (Optional) A list of table names. Any rows for tables not
in the list will not be included in the graph.
exclude_edge: (Optional) A callable used to determine whether an edge will be included in the graph. It should be of the form `f(input_row, output_row) -> bool`, where the rows are SQL-Alchemy `Row` instances. The returned graph is always connected, so any nodes that can only be reached via the edge will also be omitted.
exclude_edge: (Optional) A callable used to determine whether an edge
will be included in the graph. It should be of the form
`f(input_row, output_row) -> bool`, where the rows are SQL-Alchemy
`Row` instances. If the function returns `True` for a given pair of
nodes, then the corresponding edge is not included in the graph. The
returned graph is always connected, so any nodes that can only be
reached via the edge will also be omitted.
Raises:
TableDoesNotExist - when the specified table does not exist.
Expand Down

0 comments on commit 373d0bf

Please sign in to comment.