-
Notifications
You must be signed in to change notification settings - Fork 1.1k
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
docs: use test example to document prometheus.InstallNewPipeline #1796
docs: use test example to document prometheus.InstallNewPipeline #1796
Conversation
|
@Aneurysm9 done. One thing that concerns me is that there's already an example test which is not visible in docs. I'm not really familiar with how godoc should handle that so I don't know why it's not there. |
Those docs are from the old module (there was a versioning issue where we needed a rename). Here are the current ones with the included example. |
After
InstallNewPipeline
has been updated to return*Exporter
only, the example regardingStop()
has not been updated. To properly runStop()
you now have to get to theController
and passcontext.Context
.This PR updates
hf
toexporter
to mirrorexample/prometheus
and make it more obvious - I honestly can't say whathf
stands for.