Skip to content
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

Merged
merged 6 commits into from
Apr 13, 2021

Conversation

slagiewka
Copy link
Contributor

After InstallNewPipeline has been updated to return *Exporter only, the example regarding Stop() has not been updated. To properly run Stop() you now have to get to the Controller and pass context.Context.

This PR updates hf to exporter to mirror example/prometheus and make it more obvious - I honestly can't say what hf stands for.

@linux-foundation-easycla
Copy link

linux-foundation-easycla bot commented Apr 12, 2021

CLA Signed

The committers are authorized under a signed CLA.

@slagiewka slagiewka changed the title docs: update InstallNewPipeline example comment docs: use test example to document prometheus.InstallNewPipeline Apr 13, 2021
@slagiewka
Copy link
Contributor Author

@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.

@MrAlias
Copy link
Contributor

MrAlias commented Apr 13, 2021

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.

@MrAlias MrAlias merged commit 086abf3 into open-telemetry:main Apr 13, 2021
@slagiewka slagiewka deleted the docs_install_new_pipeline branch April 20, 2021 11:28
@MrAlias MrAlias mentioned this pull request Apr 23, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants