search

DataDog / datadogpy

The Datadog Python library
https://datadoghq.com/
Other
611 stars 302 forks source link

Non-inherited methods #100

Open mausch opened 8 years ago

mausch commented 8 years ago

At the moment http://datadogpy.readthedocs.org/en/latest/#datadog.api.Monitor.create does not display any relevant information about what kind of parameters it needs. Even worse, all the create methods show the same docs because the method is inherited from a "generic" CreateableAPIResource class.

It's the same situation for other inherited methods.

This means that I'm forced to constantly look up the actual docs at http://docs.datadoghq.com/api/#monitors because this prevents tools such as PyCharm from displaying information about the actual parameters that each method needs.

yannmh commented 8 years ago

Thanks for the feedback @mausch. Your request is completely fair.

An easy way to avoid this, would be to systematically override these 'generic' methods to add the relevant Python documentation :pencil2:. This is something we can work on soon.

zippolyte commented 4 years ago

We are leaving it to the open source community to help us here, by overriding methods and adding docstrings to them in sub classes. This may be time consuming but not difficult to implement. We would be glad to review PRs.