-
Notifications
You must be signed in to change notification settings - Fork 452
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
Enable doc generation for testing module for InMemory*Exporters. #1503
Conversation
Codecov ReportAttention:
Additional details and impacted files@@ Coverage Diff @@
## main #1503 +/- ##
=======================================
- Coverage 63.8% 63.7% -0.1%
=======================================
Files 144 144
Lines 19983 19983
=======================================
- Hits 12750 12741 -9
- Misses 7233 7242 +9 ☔ View full report in Codecov by Sentry. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Looks good for the most part will have to run docs locally to double check.
Yes agree, have validated locally and shared the screenshot of the generated docs in the PR description. |
Okay to merge? |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
testing
used to be a collection of helpers that used by other crates in this repo for unit tests. I understand it maybe helpful to open it up so users can test their custom exporters. But I think we should make sure every helper has basic documentation before merging this
Currently, only the memory exporters are made open for external users, as required by the specs. Apart from that, the |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Sounds good! Thanks for fixing it
Fixes #1466
Design discussion issue (if applicable) #
Changes
Enable doc generation for InMemory*Exporter when built with the
testing
feature. As it should be possible for users to use these exporters for testing purpose.The screenshot of the doc from this PR:
Please provide a brief description of the changes here.
Merge requirement checklist
CHANGELOG.md
files updated for non-trivial, user-facing changes