Skip to content

Commit ece2064

Browse files
Fix typos in documentation for Resampler
Signed-off-by: Daniel Zullo <[email protected]>
1 parent 5a17930 commit ece2064

File tree

1 file changed

+6
-7
lines changed

1 file changed

+6
-7
lines changed

src/frequenz/sdk/timeseries/_resampling.py

Lines changed: 6 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -146,12 +146,12 @@ class ResamplerConfig:
146146
Example:
147147
If `resampling_period_s` is 3, the input sampling period is
148148
1 and `max_data_age_in_periods` is 2, then data older than 3*2
149-
= 6 secods will be discarded when creating a new sample and never
149+
= 6 seconds will be discarded when creating a new sample and never
150150
passed to the resampling function.
151151
152152
If `resampling_period_s` is 3, the input sampling period is
153153
5 and `max_data_age_in_periods` is 2, then data older than 5*2
154-
= 10 secods will be discarded when creating a new sample and never
154+
= 10 seconds will be discarded when creating a new sample and never
155155
passed to the resampling function.
156156
"""
157157

@@ -177,7 +177,7 @@ class ResamplerConfig:
177177
"""The minimum length of the resampling buffer that will emit a warning.
178178
179179
If a buffer grows bigger than this value, it will emit a warning in the
180-
logs, so buffers don't grow too big inadvertly.
180+
logs, so buffers don't grow too big inadvertently.
181181
182182
It must be at least 1 and at most `max_buffer_len`.
183183
"""
@@ -242,12 +242,11 @@ def __init__(self, source: Source) -> None:
242242
"""Create an instance.
243243
244244
Args:
245-
source: The source of the timeseries that stopped producting
246-
samples.
245+
source: The source of the timeseries that stopped producing samples.
247246
"""
248247
super().__init__(f"Timeseries stopped producing samples, source: {source}")
249248
self.source = source
250-
"""The source of the timeseries that stopped producting samples."""
249+
"""The source of the timeseries that stopped producing samples."""
251250

252251
def __repr__(self) -> str:
253252
"""Return the representation of the instance.
@@ -672,7 +671,7 @@ def resample(self, timestamp: datetime) -> Sample:
672671
min_index = bisect(self._buffer, Sample(minimum_relevant_timestamp, None))
673672
max_index = bisect(self._buffer, Sample(timestamp, None))
674673
# Using itertools for slicing doesn't look very efficient, but
675-
# experiements with a custom (ring) buffer that can slice showed that
674+
# experiments with a custom (ring) buffer that can slice showed that
676675
# it is not that bad. See:
677676
# https://github.com/frequenz-floss/frequenz-sdk-python/pull/130
678677
# So if we need more performance beyond this point, we probably need to

0 commit comments

Comments
 (0)