Skip to content

docs: complete stacktrace and JSON package references - #79

Merged
denisvmedia merged 2 commits into
go-extras:masterfrom
PandaHUN777:docs/readme-api-60
Sep 29, 2026
Merged

denisvmedia merged 2 commits into
go-extras:masterfrom
PandaHUN777:docs/readme-api-60

Conversation

@PandaHUN777

Copy link
Copy Markdown
Contributor

Description

Update the stacktrace and json package READMEs to cover APIs and options already present in the code. The main README already documents conditional capture and ExtractAll, so this fills the remaining package-documentation gaps.

Type of Change

  • Documentation update

Related Issues

Fixes #60

Changes Made

  • Document ClassifyNew, depth-limited and conditional helpers, trace extraction, Tracer, depth constants, and %+v formatting.
  • Document the six JSON options for trace inclusion, attributes, sentinels, value transformation, path trimming, and message limits.
  • Add an Unreleased changelog entry.

Testing

  • go test ./... — passed.
  • go test -race ./... — passed.
  • go vet ./... — passed.
  • go mod tidy -diff — passed.
  • golangci-lint run --timeout=30m — passed with 0 issues.
  • govulncheck ./... — no vulnerabilities found.
  • gofmt -l on tracked Go files — clean.
  • git diff --check — passed.

Test Coverage

  • All new code is covered by tests (documentation-only change; no code added).
  • All existing tests pass (go test ./...).
  • Tests pass with race detector (go test -race ./...).

Manual Testing

Reviewed documented names and behavior against the exported APIs and existing package tests.

Documentation

  • README updated.
  • CHANGELOG updated.
  • Examples added or updated.

Code Quality

  • Changes follow the project's documentation style.
  • golangci-lint run passes.
  • go vet ./... passes.
  • Go formatting check is clean.
  • No new warnings introduced.

Breaking Changes

No.

Performance Impact

No performance impact.

Checklist

  • I have read the CONTRIBUTING guidelines.
  • All tests pass locally.
  • Documentation and CHANGELOG are updated.

@coderabbitai

coderabbitai Bot commented Sep 27, 2026 •

Copy link
Copy Markdown

Important

  • 🔍 Trigger review

This repository does not receive automatic reviews because it has fewer than 10 stars.

⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Advanced

Run ID: b82c2f2e-51e4-4cae-a940-eb7b8b131997


Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands.

Comment thread json/README.md
Comment thread json/README.md Outdated
@denisvmedia
denisvmedia added this pull request to the merge queue Sep 29, 2026
Merged via the queue into go-extras:master with commit beb3a2f Sep 29, 2026
4 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

docs: subpackage READMEs are missing APIs added in v1.3.0 and Unreleased

2 participants