DataDog / datadog-api-client-python

Python client for the Datadog API

Home Page:https://datadoghq.dev/datadog-api-client-python/

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

create_monitor documentation unreadable

pstichnothSR opened this issue · comments

Describe the bug
Something is up with the markdown in this section of the documentation: https://github.com/DataDog/datadog-api-client-python/blob/master/docs/v1/MonitorsApi.md#create_monitor

Labels
kind/bug
severity/low
documentation

To Reproduce
Go to https://github.com/DataDog/datadog-api-client-python/blob/master/docs/v1/MonitorsApi.md#create_monitor
Also visible on readthedocs here. https://datadog-api-client.readthedocs.io/en/latest/v1/MonitorsApi/#create_monitor

Expected behavior
A clear and concise description of what you expected to happen.

Screenshots
Screen Shot 2021-05-25 at 4 27 18 PM

Environment and Versions (please complete the following information):
on chrome on both GH and Readthedocs. Also reproduced by pulling the raw md into my IDE

Tried to add appropriate labels but I don't have permissions - sorry about that!

Hi,

Sorry this is an artifact of the generation, it's tough to fix. In the meantime you can see the doc properly formatted at https://docs.datadoghq.com/api/latest/monitors/#create-a-monitor. Thanks.

Fixed in #493