Skip to content

Commit ea6ac71

Browse files
robinkraftcp16net
authored andcommitted
update docs to use cloud_cover as field_name
Replaces use of `clouds` in filter docs.
1 parent db9b607 commit ea6ac71

File tree

1 file changed

+8
-8
lines changed

1 file changed

+8
-8
lines changed

planet/api/filters.py

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -56,16 +56,16 @@ def and_filter(*predicates):
5656
'''Build an `and` filter from the provided predicate filters.
5757
5858
>>> filt = and_filter(
59-
... range_filter('clouds', gt=0.1),
60-
... range_filter('clouds', lt=0.2)
59+
... range_filter('cloud_cover', gt=0.1),
60+
... range_filter('cloud_cover', lt=0.2)
6161
... )
6262
>>> filt['type']
6363
'AndFilter'
6464
>>> filt['config'][0] == \
65-
{'config': {'gt': 0.1}, 'field_name': 'clouds', 'type': 'RangeFilter'}
65+
{'config': {'gt': 0.1}, 'field_name': 'cloud_cover', 'type': 'RangeFilter'}
6666
True
6767
>>> filt['config'][1] == \
68-
{'config': {'lt': 0.2}, 'field_name': 'clouds', 'type': 'RangeFilter'}
68+
{'config': {'lt': 0.2}, 'field_name': 'cloud_cover', 'type': 'RangeFilter'}
6969
True
7070
'''
7171
return _filter('AndFilter', predicates)
@@ -78,7 +78,7 @@ def or_filter(*predicates):
7878
>>> n = datetime.datetime(year=2017, month=2, day=14)
7979
>>> filt = or_filter(
8080
... date_range('acquired', gt=n),
81-
... range_filter('clouds', gt=0.1),
81+
... range_filter('cloud_cover', gt=0.1),
8282
... )
8383
>>> filt['type']
8484
'OrFilter'
@@ -87,7 +87,7 @@ def or_filter(*predicates):
8787
'type': 'DateRangeFilter'}
8888
True
8989
>>> filt['config'][1] == \
90-
{'config': {'gt': 0.1}, 'field_name': 'clouds', 'type': 'RangeFilter'}
90+
{'config': {'gt': 0.1}, 'field_name': 'cloud_cover', 'type': 'RangeFilter'}
9191
True
9292
'''
9393
return _filter('OrFilter', predicates)
@@ -123,8 +123,8 @@ def date_range(field_name, **kwargs):
123123
def range_filter(field_name, **kwargs):
124124
'''Build a RangeFilter.
125125
126-
>>> range_filter('clouds', gt=0.1) == \
127-
{'config': {'gt': 0.1}, 'field_name': 'clouds', 'type': 'RangeFilter'}
126+
>>> range_filter('cloud_cover', gt=0.1) == \
127+
{'config': {'gt': 0.1}, 'field_name': 'cloud_cover', 'type': 'RangeFilter'}
128128
True
129129
'''
130130
return _filter('RangeFilter', config=kwargs, field_name=field_name)

0 commit comments

Comments
 (0)