bosun-monitor / bosun

Time Series Alerting Framework
http://bosun.org
MIT License
3.4k stars 495 forks source link

Update the documentation for dropbool #2497

Closed muffix closed 3 years ago

muffix commented 3 years ago

Description

Fixes the documentation which described the behaviour of dropbool incorrectly. dropbool() currently drops the values where the value in the second series set IS zero instead of, as described, dropping those where the value IS NOT zero. To avoid a breaking change which would give the function the more intuitive behaviour from its name, this only updates the documentation.

We should consider fixing this with a breaking change in a future release.

Fixes #2496

Type of change

How has this been tested?

The behaviour is the inverse of the previously described behaviour. The description is fixed with this PR.

Checklist: