cognitect / cognitect/transit-java
Clarify that JSON Encoding uses UTF-8
Open
Nobody has claimed this yet.
- Dominant language
- Java
- Stars
- 65
- Forks
- 23
- PR merge metrics
- No merged PRs in 30d
Description
In WriterFactory.getJsonInstance(...) jf.createGenerator(out) is called which uses UTF-8 as default. It would be nice to document the usage of UTF-8 in TransitFactory.writer(...).
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start with WriterFactory.getJsonInstance(...) and TransitFactory.writer(...), then inspect the surrounding documentation and the createGenerator(out) call. Document that JSON encoding uses UTF-8 by default; the work is done when TransitFactory.writer(...) clearly communicates this behavior.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- java
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 55/100