docs: add JSON package reference to main README #5
Conversation
This file contains hidden or 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
- Add JSON serialization as fifth key capability in Overview - Add JSON serialization feature to Features list - Add comprehensive JSON Serialization section with examples - Include configuration options and key features - Update zero dependencies note to mention json package - Position JSON section between stacktrace and compat sections
There was a problem hiding this comment.
Pull request overview
This PR adds comprehensive documentation for the json subpackage to the main README, improving discoverability of the JSON serialization capabilities.
Changes:
- Updated overview to mention five key capabilities instead of four
- Added JSON serialization to the features list
- Added a comprehensive JSON Serialization section with usage examples and configuration options
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| jsonBytes, _ := errxjson.Marshal(err) | ||
|
|
||
| // Pretty print | ||
| jsonBytes, _ := errxjson.MarshalIndent(err, "", " ") |
There was a problem hiding this comment.
The variable jsonBytes is being redeclared here, which will shadow the previous declaration on line 358. The second assignment should use = instead of :=, or use a different variable name to avoid confusion.
Suggested change
| jsonBytes, _ := errxjson.MarshalIndent(err, "", " ") | |
| jsonBytes, _ = errxjson.MarshalIndent(err, "", " ") |
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.
Description
The main README was missing a reference to the package, which provides JSON serialization capabilities for errx errors. This PR adds comprehensive documentation about the json package to make it more discoverable for users.
Type of Change
Related Issues
N/A - Documentation improvement
Changes Made
Testing
Test Coverage
go test ./...)go test -race ./...) (N/A - documentation only)Manual Testing
Documentation
Code Quality
go vetpasses (N/A - documentation only)go fmthas been run (N/A - documentation only)Breaking Changes
Does this PR introduce breaking changes?
Performance Impact
Additional Notes
This is a documentation-only change that improves discoverability of the existing json package. The json package itself has been in the repository but was not mentioned in the main README, making it less visible to users.
Checklist