This repository has been archived by the owner on Dec 8, 2022. It is now read-only.
chores(docs): Move example from markdown to tests #89
Conversation
This file contains 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
It's required because: - package users can use godoc.org, pkg.go.dev for exploring the package documentation - testable examples can be more in sync with actual code This commit moves examples from the plain markdown to testable examples. It allows to test examples during test phase and have them more in sync with actual code. Also the examples can be shown by documentation servers and in IDEs and make work with package much more user-friendly as not everyone looks into README.md at repo's root. Related to #68
Codecov Report
@@ Coverage Diff @@
## master #89 +/- ##
=======================================
Coverage 94.92% 94.92%
=======================================
Files 10 10
Lines 965 965
=======================================
Hits 916 916
Misses 27 27
Partials 22 22 Continue to review full report at Codecov.
|
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
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.
It's required because:
the package documentation
This commit moves examples from the plain markdown to testable
examples. It allows to test examples during test phase and have
them more in sync with actual code. Also the examples can be
shown by documentation servers and in IDEs and make work with
package much more user-friendly as not everyone looks into
README.md at repo's root.
Related to #68
Screenshot of godoc server [collapsible]
Ref: Testable Examples in Go - The Go Blog