Skip to content

Commit af4be16

Browse files
author
Nick Clarke
committed
Fix bullet point lists in query builder docstrings
1 parent e0aa4ea commit af4be16

File tree

1 file changed

+7
-4
lines changed

1 file changed

+7
-4
lines changed

python/arcticdb/version_store/processing.py

+7-4
Original file line numberDiff line numberDiff line change
@@ -325,7 +325,6 @@ class QueryBuilder:
325325
Supported arithmetic operations when projection or filtering:
326326
327327
* Binary arithmetic: +, -, *, /
328-
329328
* Unary arithmetic: -, abs
330329
331330
Supported filtering operations:
@@ -337,11 +336,8 @@ class QueryBuilder:
337336
>>> q = q[q["col"].isna()]
338337
339338
* Binary comparisons: <, <=, >, >=, ==, !=
340-
341339
* Unary NOT: ~
342-
343340
* Binary combinators: &, |, ^
344-
345341
* List membership: isin, isnotin (also accessible with == and !=)
346342
347343
isin/isnotin accept lists, sets, frozensets, 1D ndarrays, or *args unpacking. For example:
@@ -448,6 +444,7 @@ def groupby(self, name: str):
448444
"""
449445
Group symbol by column name. GroupBy operations must be followed by an aggregation operator. Currently the following five aggregation
450446
operators are supported:
447+
451448
* "mean" - compute the mean of the group
452449
* "sum" - compute the sum of the group
453450
* "min" - compute the min of the group
@@ -574,21 +571,26 @@ def resample(
574571
"""
575572
Resample symbol on the index. Symbol must be datetime indexed. Resample operations must be followed by an
576573
aggregation operator. Currently, the following 7 aggregation operators are supported:
574+
577575
* "mean" - compute the mean of the group
578576
* "sum" - compute the sum of the group
579577
* "min" - compute the min of the group
580578
* "max" - compute the max of the group
581579
* "count" - compute the count of group
582580
* "first" - compute the first value in the group
583581
* "last" - compute the last value in the group
582+
584583
Note that not all aggregators are supported with all column types.:
584+
585585
* Numeric columns - support all aggregators
586586
* Bool columns - support all aggregators
587587
* String columns - support count, first, and last aggregators
588588
* Datetime columns - support all aggregators EXCEPT sum
589+
589590
Note that time-buckets which contain no index values in the symbol will NOT be included in the returned
590591
DataFrame. This is not the same as Pandas default behaviour.
591592
Resampling is currently not supported with:
593+
592594
* Dynamic schema where an aggregation column is missing from one or more of the row-slices.
593595
* Sparse data.
594596
@@ -619,6 +621,7 @@ def resample(
619621
The closed or label arguments are not one of "left" or "right"
620622
SchemaException
621623
Raised on call to read if:
624+
622625
* If the aggregation specified is not compatible with the type of the column being aggregated as
623626
specified above.
624627
* The library has dynamic schema enabled, and at least one of the columns being aggregated is missing

0 commit comments

Comments
 (0)