Skip to content

Commit

Permalink
improv(core): Improve docstrings for first/last aggregators.
Browse files Browse the repository at this point in the history
  • Loading branch information
JovanVeljanoski committed Feb 21, 2022
1 parent db0afc3 commit 7e022c4
Show file tree
Hide file tree
Showing 2 changed files with 17 additions and 3 deletions.
18 changes: 16 additions & 2 deletions packages/vaex-core/vaex/agg.py
Original file line number Diff line number Diff line change
Expand Up @@ -463,12 +463,25 @@ def max(expression, selection=None, edges=False):

@register
def first(expression, order_expression=None, selection=None, edges=False):
'''Creates a first aggregation'''
'''Creates a first aggregation.
:param expression: {expression_one}.
:param order_expression: Order the values in the bins by this expression.
:param selection: {selection1}
:param edges: {edges}
'''
return AggregatorDescriptorBasic('AggFirst', [expression, order_expression] if order_expression is not None else expression, 'first', multi_args=True, selection=selection, edges=edges, agg_args=[False])

@register
@docsubst
def last(expression, order_expression=None, selection=None, edges=False):
'''Creates a first aggregation'''
'''Creates a first aggregation.
:param expression: {expression_one}.
:param order_expression: Order the values in the bins by this expression.
:param selection: {selection1}
:param edges: {edges}
'''
return AggregatorDescriptorBasic('AggFirst', [expression, order_expression] if order_expression is not None else expression, 'last', multi_args=True, selection=selection, edges=edges, agg_args=[True])

@register
Expand All @@ -482,6 +495,7 @@ def var(expression, ddof=0, selection=None, edges=False):
return AggregatorDescriptorVar('var', expression, 'var', ddof=ddof, selection=selection, edges=edges)

@register
@docsubst
def nunique(expression, dropna=False, dropnan=False, dropmissing=False, selection=None, edges=False):
"""Aggregator that calculates the number of unique items per bin.
Expand Down
2 changes: 1 addition & 1 deletion packages/vaex-core/vaex/dataframe.py
Original file line number Diff line number Diff line change
Expand Up @@ -972,7 +972,7 @@ def first(self, expression, order_expression=None, binby=[], limits=None, shape=
array([-4.81883764, 11.65378 , 9.70084476, -7.3025589 , 4.84954977,
8.47446537, -5.73602629, 10.18783 ])
:param expression: The value to be placed in the bin.
:param expression: {expression}
:param order_expression: Order the values in the bins by this expression.
:param binby: {binby}
:param limits: {limits}
Expand Down

0 comments on commit 7e022c4

Please sign in to comment.