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.

Sign up for GitHub

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

Jump to bottom

NewDefaultAuditEventWriter: Fix documentation #124

Open
stephen-fox opened this issue Nov 29, 2022 · 1 comment
Open

NewDefaultAuditEventWriter: Fix documentation #124

stephen-fox opened this issue Nov 29, 2022 · 1 comment
Labels
bug Something isn't working

Comments

@stephen-fox
Copy link

The Go Doc for NewDefaultAuditEventWriter says:

// AuditEventEncoderJSON is an encoder that encodes audit events
// using a default JSON encoder.

Is AuditEventEncoderJSON a typo in the documentation, or should that be the function's name? Is the function supposed to use a JSON encoder?
@stephen-fox stephen-fox added the bug Something isn't working label Nov 29, 2022
@JAORMX
Copy link
Collaborator

JAORMX commented Nov 30, 2022

@stephen-fox it's a leftover from the initial implementation. That doc needs to be rewritten.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
bug Something isn't working
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
2 participants
@JAORMX @stephen-fox