Add docstring to buckets method

This commit is contained in:
Darren Burns
2022-02-08 16:49:30 +00:00
parent 8f95afd6c8
commit 17d1ed335a

View File

@@ -41,6 +41,13 @@ class Sparkline:
@classmethod @classmethod
def _buckets(cls, data: Sequence[T], num_buckets: int) -> Iterable[list[T]]: def _buckets(cls, data: Sequence[T], num_buckets: int) -> Iterable[list[T]]:
"""Partition ``data`` into ``num_buckets`` buckets. For example, the data
[1, 2, 3, 4] partitioned into 2 buckets is [[1, 2], [3, 4]].
Args:
data (Sequence[T]): The data to partition.
num_buckets (int): The number of buckets to partition the data into.
"""
num_steps, remainder = divmod(len(data), num_buckets) num_steps, remainder = divmod(len(data), num_buckets)
for i in range(num_buckets): for i in range(num_buckets):
start = i * num_steps + min(i, remainder) start = i * num_steps + min(i, remainder)