Skip to content

Documentation improvements #4

Description

@elliotdavies

The docs for this library are really good! A couple of small things I noticed:

-- Prom.withMetricIO _msGauge (Prom.setGauge 3.0)

I think this needs a flip like so: Prom.withMetricIO _msGauge (flip Prom.setGauge 3.0). That may also be true for the other examples in that section.

-- You can add support for Prometheus metrics by @deriving@ an instance of
-- 'MonadPrometheus' @via@ this module's 'PrometheusT' type:

If I'm inside App and use Prom.withMetric with a function like Prom.setGauge then I'm told there's no instance for Prom.MonadMonitor App. (Prom.withMetricIO works fine.) Perhaps I made a mistake, but if not it would be worth documenting that the instance is needed.

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions