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

[IDEA] Clarify the FilterFunc return value functionality #44

Open
braydonk opened this issue Dec 15, 2021 · 0 comments
Open

[IDEA] Clarify the FilterFunc return value functionality #44

braydonk opened this issue Dec 15, 2021 · 0 comments
Labels
enhancement New feature or request

Comments

@braydonk
Copy link

braydonk commented Dec 15, 2021

Thank you for this zap core, it was a big help to myself and my team!

Is your feature request related to a problem? Please describe.
The documentation for FilterFunc does not mention when to return true or false. Because of the language of this being a filtering function, it was confusing to me figuring out whether true meant yes, filter the log, or if it meant yes, send the log through. I had to do some manual testing to figure it out.

Describe the solution you'd like
The documentation for FilterFunc should make some mention what happens under true and false return values from it. Something along the lines of:
"If this function returns true, the log will be let through, otherwise it will be filtered"
(I'm new to zap in general, there may be terminology that makes more sense in this context)

@braydonk braydonk added the enhancement New feature or request label Dec 15, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

1 participant