Skip to content

docs: clarify zapcore Entry documentation#1550

Open
tatakaisun wants to merge 1 commit into
uber-go:masterfrom
tatakaisun:docs/1037-update-entry-doc
Open

docs: clarify zapcore Entry documentation#1550
tatakaisun wants to merge 1 commit into
uber-go:masterfrom
tatakaisun:docs/1037-update-entry-doc

Conversation

@tatakaisun

Copy link
Copy Markdown

Summary

  • Clarifies the zapcore.Entry doc comment to describe it as fixed metadata for a log event.
  • Removes the outdated note that entries are pooled.
  • Notes that structured context is supplied separately as fields to Core.Write and encoded by the configured encoder.

Why

Issue #1037 points out that the previous comment described Entry as a complete log message and warned about pooling, both of which are outdated or misleading.

Changes

  • Updated the Entry comment in zapcore/entry.go.
  • No behavior changes.

Testing

  • git diff --check
  • git diff --cached --check

Not run:

  • go test ./zapcore because Go is not installed in this environment.

Known Issues

None.

Closes #1037

@CLAassistant

CLAassistant commented Jun 9, 2026

Copy link
Copy Markdown

CLA assistant check
All committers have signed the CLA.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Development

Successfully merging this pull request may close these issues.

zapcore.Entry documentation is outdated

2 participants