Skip to content

Commit 9ee1c01

Browse files
committed
clarified where/argwhere docstrings
1 parent 999a535 commit 9ee1c01

1 file changed

Lines changed: 20 additions & 6 deletions

File tree

gnss_lib_py/parsers/navdata.py

Lines changed: 20 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -270,12 +270,20 @@ def where(self, key_idx, value, condition="eq"):
270270
For string rows, only the "eq" and "neq" conditions are valid.
271271
The "value" argument can contain either a string, np.nan or an
272272
array-like object of strings. If an array-like object of strings
273-
is passed in then np.isin() is used to check the condition.
273+
is passed in then np.isin() is used to check the condition
274+
meaning that the returned subset will contain one of the values
275+
in the "value" array-like object for the "eq" condition or none
276+
of the values in the "value" array-like object for the "neq"
277+
condition.
274278
275279
For non-string rows, all valid conditions are listed in the
276280
"condition" argument description. The "value" argument can either
277281
contain a numeric or an array-like object of numerics for both
278282
the "eq" and "neq" conditions.
283+
If an array-like object is passed then the returned subset will
284+
contain one of the values in the "value" array-like object for
285+
the "eq" condition or none of the values in the "value"
286+
array-like object for the "neq" condition.
279287
For the "between" condition, the two limit values must be passed
280288
into the "value" argument as an array-like object.
281289
@@ -290,8 +298,7 @@ def where(self, key_idx, value, condition="eq"):
290298
Condition type (greater than ("greater")/ less than ("lesser")/
291299
equal to ("eq")/ greater than or equal to ("geq")/
292300
lesser than or equal to ("leq") / in between ("between")
293-
inclusive of the provided limits / not equal to ("neq")/
294-
is in value subset ("isin") / not in value subset (nisin))
301+
inclusive of the provided limits / not equal to ("neq"))
295302
296303
Returns
297304
-------
@@ -311,12 +318,20 @@ def argwhere(self, key_idx, value, condition="eq"):
311318
For string rows, only the "eq" and "neq" conditions are valid.
312319
The "value" argument can contain either a string, np.nan or an
313320
array-like object of strings. If an array-like object of strings
314-
is passed in then np.isin() is used to check the condition.
321+
is passed in then np.isin() is used to check the condition
322+
meaning that the returned subset will contain one of the values
323+
in the "value" array-like object for the "eq" condition or none
324+
of the values in the "value" array-like object for the "neq"
325+
condition.
315326
316327
For non-string rows, all valid conditions are listed in the
317328
"condition" argument description. The "value" argument can either
318329
contain a numeric or an array-like object of numerics for both
319330
the "eq" and "neq" conditions.
331+
If an array-like object is passed then the returned subset will
332+
contain one of the values in the "value" array-like object for
333+
the "eq" condition or none of the values in the "value"
334+
array-like object for the "neq" condition.
320335
For the "between" condition, the two limit values must be passed
321336
into the "value" argument as an array-like object.
322337
@@ -331,8 +346,7 @@ def argwhere(self, key_idx, value, condition="eq"):
331346
Condition type (greater than ("greater")/ less than ("lesser")/
332347
equal to ("eq")/ greater than or equal to ("geq")/
333348
lesser than or equal to ("leq") / in between ("between")
334-
inclusive of the provided limits / not equal to ("neq")/
335-
is in value subset ("isin") / not in value subset (nisin))
349+
inclusive of the provided limits / not equal to ("neq"))
336350
337351
Returns
338352
-------

0 commit comments

Comments
 (0)