Skip to content

Commit

Permalink
fix: docs build issue
Browse files Browse the repository at this point in the history
  • Loading branch information
johnson2427 committed May 12, 2022
1 parent 0637c3f commit faadc8c
Showing 1 changed file with 5 additions and 0 deletions.
5 changes: 5 additions & 0 deletions src/ape/managers/query.py
Original file line number Diff line number Diff line change
Expand Up @@ -52,6 +52,7 @@ class QueryManager(ManagerAccessMixin):
A singleton that manages query engines and performs queries.
Args:
query (``QueryType``): query to execute
Usage example::
biggest_block_size = chain.blocks.query("size").max()
"""
Expand All @@ -61,6 +62,7 @@ def engines(self) -> Dict[str, QueryAPI]:
"""
A dict of all :class:`~ape.api.query.QueryAPI` instances across all
installed plugins.
Returns:
dict[str, :class:`~ape.api.query.QueryAPI`]
"""
Expand All @@ -79,11 +81,14 @@ def query(self, query: QueryType, engine_to_use: Optional[str] = None) -> pd.Dat
query (``QueryType``): The type of query to execute
engine_to_use (Optional[str]): Short-circuit selection logic using
a specific engine. Defaults to None.
Raises: :class:`~ape.exceptions.QueryEngineError`: When given an
invalid or inaccessible ``engine_to_use`` value.
Returns:
pandas.DataFrame
"""

if engine_to_use:
if engine_to_use not in self.engines:
raise QueryEngineError(f"Query engine `{engine_to_use}` not found.")
Expand Down

0 comments on commit faadc8c

Please sign in to comment.