Skip to content

Commit

Permalink
Tidy up the docstring
Browse files Browse the repository at this point in the history
  • Loading branch information
MrCurtis committed Jan 30, 2024
1 parent 275e6fe commit 919a853
Showing 1 changed file with 11 additions and 3 deletions.
14 changes: 11 additions & 3 deletions src/fk_graph/edge_excluders.py
Original file line number Diff line number Diff line change
@@ -1,9 +1,17 @@
"""Edge Excluders.
Functions to pass in as an `exclude_edge` argument to `get_graph`.
"""

def input_row_is_in_tables(table_names):
"""
"""Checks whether input row-node is in list of tables.
This is typically used in cases where one wishes to include rows from a table as nodes in the graph..
For example, if there is a `user` table with f.k relation to a `country` table, one might want to include the country that a user is from, but not also include all the other users that are from that country.
This is typically used in cases where one wishes to include rows from a
table as nodes in the graph, but *not* include the subsequent rows which
can only be reached via these nodes.
For example, if there is a `user` table with f-k relation to a `country`
table, one might want to include the country that a user is from, but not
also include all the other users that are from that country.
Args:
table_names: A list of table names.
Expand Down

0 comments on commit 919a853

Please sign in to comment.