docs: move ext readmes to docstring #475
Closed
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This commit moves the text on the readmes of the external packages to their source code as a docstring. This improves the generated documentation and helps to consolidate the documentation in a single place. This commit uniforms all the readmes present on each packager, they only contain a 1 line description, installation instructions and a link to the online documentation of such package. This small readme will be the one shown on Github and on PyPI. The full documentation will be generated by autodoc and stored in readthedocs or whatever site we choose.
Codecov Report
@@ Coverage Diff @@
## master #475 +/- ##
=======================================
Coverage 88.97% 88.97%
=======================================
Files 43 43
Lines 2213 2214 +1
Branches 248 248
=======================================
+ Hits 1969 1970 +1
Misses 173 173
Partials 71 71
Continue to review full report at Codecov.
|
|
Closing in favor of #483 that already contains the changes here. |
srikanthccv
pushed a commit
to srikanthccv/opentelemetry-python
that referenced
this pull request
Nov 1, 2020
* feat: add shutdown method on MetricExporter interface * fix: update JSDoc comment
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This commit moves the text on the readmes of the external packages to their
source code as a docstring. This improves the generated documentation and helps
to consolidate the documentation in a single place.
This commit uniforms all the readmes present on each packager, they only contain
a 1 line description, installation instructions and a link to the online
documentation of such package. This small readme will be the one shown on Github
and on PyPI.
The full documentation will be generated by autodoc and stored in readthedocs
or whatever site we choose.