From 5f2bd9babcbb7e1984523b0c89afccc436e9f448 Mon Sep 17 00:00:00 2001 From: Sean Breckenridge Date: Sat, 15 Apr 2023 14:12:11 -0700 Subject: [PATCH] docs: update python reference --- doc/QUERY.md | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/doc/QUERY.md b/doc/QUERY.md index 8ae6d46..24d5ef7 100644 --- a/doc/QUERY.md +++ b/doc/QUERY.md @@ -63,6 +63,7 @@ Options: raised) from the functions, raise them --drop-exceptions ignore any errors returned as objects from the functions + --help Show this message and exit. ``` This works with any function which returns an iterable, for example `my.coding.commits`, which searches for `git commit`s on your computer: @@ -198,7 +199,7 @@ To preview, you can use something like [`qgis`](https://qgis.org/en/site/) or fo The `hpi query` command is a CLI wrapper around the code in [`query.py`](../my/core/query.py) and [`query_range.py`](../my/core/query_range.py). The `select` function is the core of this, and `select_range` lets you specify dates, timedelta, start-end ranges, and other CLI-specific code. -`select`: +`my.core.query.select`: ``` A function to query, order, sort and filter items from one or more sources @@ -278,7 +279,7 @@ The `hpi query` command is a CLI wrapper around the code in [`query.py`](../my/c raise_exceptions: raise exceptions when received from the input src ``` -`select_range`: +`my.core.query_range.select_range`: ``` A specialized select function which offers generating functions