Skip to content
This repository has been archived by the owner on Apr 22, 2020. It is now read-only.

Correct and extend documentation on value_series #126

Open
rmminusrslash opened this issue Jan 17, 2019 · 1 comment
Open

Correct and extend documentation on value_series #126

rmminusrslash opened this issue Jan 17, 2019 · 1 comment
Labels
bug user-reported issues that take more than one hour to resolve chore technical debts, operational excellence, compliance and minor security topics, re-factoring needs documentation For tickets about or tasks necessitating the update of documentation

Comments

@rmminusrslash
Copy link

https://docs.zmon.io/en/latest/user/alert-ref/alert_reference_functions.html#value_series

  1. Bug: the argument listed in the doc (n=) raises an exception. In reality, this argument is not named.
  2. Since one can not trial run the function it would be nice to document the return value. The function returns a list of prior check results with the most recent one being at position 0
@mohabusama mohabusama added feature improvements, enhancement, functionality requested by users bug user-reported issues that take more than one hour to resolve labels Jan 17, 2019
@mohabusama
Copy link
Contributor

Thanks!
Correct var name (count=). Should be removed anyway until we generate docs from code.

@laceyallyn laceyallyn added chore technical debts, operational excellence, compliance and minor security topics, re-factoring needs and removed feature improvements, enhancement, functionality requested by users labels Apr 18, 2019
@alexkorotkikh alexkorotkikh added the documentation For tickets about or tasks necessitating the update of documentation label May 14, 2019
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
bug user-reported issues that take more than one hour to resolve chore technical debts, operational excellence, compliance and minor security topics, re-factoring needs documentation For tickets about or tasks necessitating the update of documentation
Projects
None yet
Development

No branches or pull requests

4 participants