Skip to content

Commit

Permalink
docs: revise NullFilterMap docstring description with refs to the api
Browse files Browse the repository at this point in the history
Refs #10
  • Loading branch information
Aesonus committed Oct 19, 2024
1 parent fc45fda commit 66ed16d
Showing 1 changed file with 3 additions and 1 deletion.
4 changes: 3 additions & 1 deletion alchemical_storage/filter/filter.py
Original file line number Diff line number Diff line change
Expand Up @@ -152,7 +152,9 @@ def _generate_order_by(self, order_by: str):


class NullFilterMap(StatementVisitor):
"""Applies a ``IS NULL`` or ``IS NOT NULL`` filter to an sqlalchemy statement.
"""Maps :meth:`FilterMap.visit_statement<.FilterMap.visit_statement>` ``params``
argument dict keys to ``sqlalchemy.Select.where`` calls specifically for ``NULL`` or
``NOT NULL`` filters.
Arguments:
filters: A dictionary of filters
Expand Down

0 comments on commit 66ed16d

Please sign in to comment.