Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Mention units explicitly #233

Merged
merged 1 commit into from
Jun 13, 2019
Merged

Mention units explicitly #233

merged 1 commit into from
Jun 13, 2019

Conversation

pratikmallya
Copy link
Contributor

@pratikmallya pratikmallya commented Jun 11, 2019

All of the parameters are in seconds: https://docs.datadoghq.com/api/?lang=python#create-a-test.

There can be some confusion because some datadog docs say its in
minutes e.g. in https://docs.datadoghq.com/synthetics/api_tests/?tab=httptest#alert-conditions
it is mentioned:

At least one location was in failure (at least one assertion failed) during the last X minutes,

Also, one of the parameters is called min_failure_duration,
which caused some confusion whether the min referred to
minimum or minutes : ).

Specify the units explicilty, and save others from being confused
like we were.

All of the parameters are in seconds: https://docs.datadoghq.com/api/?lang=python#create-a-test.

There can be some confusion because some datadog docs say its in
minutes e.g. in https://docs.datadoghq.com/synthetics/api_tests/?tab=httptest#alert-conditions
it is mentioned:
```
At least one location was in failure (at least one assertion failed) during the last X minutes,
```

Also, one of the parameters is called `min_failure_duration`,
which caused some confusion whether the `min` referred to
minimum or minutes : ).

Specify the units explicilty, and save others from being confused
like we were.
Copy link
Contributor

@nmuesch nmuesch left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for the PR! Looks good to me 🚀

@nmuesch nmuesch merged commit 19e2ae8 into DataDog:master Jun 13, 2019
@pratikmallya pratikmallya deleted the improve_docs branch June 13, 2019 20:52
jbenais pushed a commit to jbenais/terraform-provider-datadog that referenced this pull request Aug 20, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants