Add mapval doc.go #7944
Merged
Add mapval doc.go #7944
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
houndci-bot
reviewed
Aug 10, 2018
libbeat/common/mapval/is_defs.go
Outdated
| return strV, nil | ||
| } | ||
|
|
||
| var IsNonEmptyString = Is("is a non-empty string", func(path Path, v interface{}) *Results { |
There was a problem hiding this comment.
exported var IsNonEmptyString should have comment or be unexported
libbeat/common/mapval/doc.go
Outdated
|
|
||
| Examples of usage are found in doc_test.go | ||
| */ | ||
|
|
There was a problem hiding this comment.
package comment is detached; there should be no blank lines between it and the package statement
andrewvc
force-pushed
the
add_mapval_docs_root
branch
from
b3bf473 to
73f3930
Compare
andrewvc
force-pushed
the
add_mapval_docs_root
branch
2 times, most recently
from
ac2ca07 to
ae7b64e
Compare
This cleans up the docs for mapval. The various Path related functions were public, and thus cluttering up the docs, though there was no need for them to be so. This adds examples and some high-level docs.
andrewvc
force-pushed
the
add_mapval_docs_root
branch
from
ae7b64e to
e068037
Compare
andrewvc
added
review
and removed
in progress
ruflin
approved these changes
Aug 21, 2018
| /* | ||
| Package mapval is used to validate JSON-like nested map data-structure against a set of expectations. Its key features are allowing custom, function defined validators for values, and allowing the composition of multiple validation specs. | ||
|
|
||
| See the example below for more details. Most key functions include detailed examples of their use within this documentation. |
There was a problem hiding this comment.
So the doc_test Example()` function will be show in the godocs? Nice, didn't know.
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.
Adds doc.go and doc_test.go for examples.
This is currently based on #7545 . Reviewing doesn't make sense until that is merged.