Skip to content

Commit b9dbb5d

Browse files
committed
fixing docstring
1 parent fd54d69 commit b9dbb5d

File tree

2 files changed

+3
-1
lines changed

2 files changed

+3
-1
lines changed

readthedocs/search/mixins.py

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,7 @@ class RTDDocTypeMixin(object):
1515
"""
1616

1717
def _prepare_action(self, object_instance, action, index_name=None):
18+
"""Overwrite to take `index_name` from parameters for setting index dynamically"""
1819
return {
1920
'_op_type': action,
2021
'_index': index_name or str(self._doc_type.index),
@@ -26,6 +27,7 @@ def _prepare_action(self, object_instance, action, index_name=None):
2627
}
2728

2829
def _get_actions(self, object_list, action, index_name=None):
30+
"""Overwrite to take `index_name` from parameters for setting index dynamically"""
2931
if self._doc_type.queryset_pagination is not None:
3032
paginator = Paginator(
3133
object_list, self._doc_type.queryset_pagination

readthedocs/search/utils.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -324,7 +324,7 @@ def get_project_list_or_404(project_slug, user):
324324

325325

326326
def chunks(elements, chunk_size):
327-
"""Yield successive n-sized chunks from l."""
327+
"""Yield successive `chunk_size` chunks from elements."""
328328
# Taken from https://stackoverflow.com/a/312464
329329
# licensed under cc by-sa 3.0
330330
for i in range(0, len(elements), chunk_size):

0 commit comments

Comments
 (0)