Skip to content

Commit

Permalink
docs: Improve docs on update method
Browse files Browse the repository at this point in the history
  • Loading branch information
NikolasEnt committed Apr 16, 2024
1 parent 2e2ad7d commit 03f4982
Showing 1 changed file with 1 addition and 1 deletion.
2 changes: 1 addition & 1 deletion argus/utils.py
Original file line number Diff line number Diff line change
Expand Up @@ -224,7 +224,7 @@ def update(self, value, n: int = 1):
Args:
value: Value to update the average meter with.
n (int, optional): Number of elements accumulated by the value.
Defaults to 1.
Should be positive. Defaults to 1.
"""
self.count += n
self.average += (value - self.average * n) / self.count

0 comments on commit 03f4982

Please sign in to comment.