Skip to content

Commit bb32b4b

Browse files
committed
minor: change to bucketSize index args documentation
1 parent 4b7cc70 commit bb32b4b

File tree

1 file changed

+6
-4
lines changed

1 file changed

+6
-4
lines changed

pymongo/collection.py

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -752,8 +752,9 @@ def create_index(self, key_or_list, cache_for=300, **kwargs):
752752
- `dropDups` or `drop_dups`: should we drop duplicates
753753
- `background`: if this index should be created in the
754754
background
755-
- `bucketSize` or `bucket_size`: size of buckets for geoHaystack
756-
indexes during index creation when creating a unique index?
755+
- `bucketSize` or `bucket_size`: for use with geoHaystack indexes.
756+
Number of documents to group together within a certain proximity
757+
to a given longitude and latitude.
757758
- `min`: minimum value for keys in a :data:`~pymongo.GEO2D`
758759
index
759760
- `max`: maximum value for keys in a :data:`~pymongo.GEO2D`
@@ -863,8 +864,9 @@ def ensure_index(self, key_or_list, cache_for=300, **kwargs):
863864
during index creation when creating a unique index?
864865
- `background`: if this index should be created in the
865866
background
866-
- `bucketSize` or `bucket_size`: size of buckets for geoHaystack
867-
indexes during index creation when creating a unique index?
867+
- `bucketSize` or `bucket_size`: for use with geoHaystack indexes.
868+
Number of documents to group together within a certain proximity
869+
to a given longitude and latitude.
868870
- `min`: minimum value for keys in a :data:`~pymongo.GEO2D`
869871
index
870872
- `max`: maximum value for keys in a :data:`~pymongo.GEO2D`

0 commit comments

Comments
 (0)