The method signature is pretty awful because of backwards compatibility, and we don't really want to expose the deprecated options to the end user. By using the @!method macro, we can override the signature from Yard's point of view.
I have decided not to document a couple of keyword arguments because I may want to drop support of these in the new version:
prefix
no_prefix
as_dist (I think this might be an internal only thing)
It turns out that many of the arguments are for the datadog-only event and service_check metrics are not actually used. To start, I have decided to simply hide all of them. In the new implementation, we should remove them from the method signature.
I've also added some examples, and properly documented the methods that optionally accept a block (measure and distribution)
The method signature is pretty awful because of backwards compatibility, and we don't really want to expose the deprecated options to the end user. By using the
@!methodmacro, we can override the signature from Yard's point of view.I have decided not to document a couple of keyword arguments because I may want to drop support of these in the new version:
prefixno_prefixas_dist(I think this might be an internal only thing)It turns out that many of the arguments are for the datadog-only
eventandservice_checkmetrics are not actually used. To start, I have decided to simply hide all of them. In the new implementation, we should remove them from the method signature.I've also added some examples, and properly documented the methods that optionally accept a block (
measureanddistribution)