audreyfeldroy / audreyfeldroy/standardjson
FAQ suggestion: explain relationship with DjangoJSONEncoder
- Dominant language
- Python
- Stars
- 18
- Forks
- 1
- PR merge metrics
- No merged PRs in 30d
Description
I came across this library and wondered if it there was a reason to replace my use of DjangoJSONEncoder with StandardJSONEncoder.
Another issue mentions that parts of StandardJSONEncoder were extracted from DjangoJSONEncoder and it looks superficially similar.
Obviously StandardJSONEncoder is a much smaller dependency if you need this feature in a non-Django project. That's a sufficient reason for this project to exist.
StandardJSONEncoder also supports fewer types compared to DjangoJSONEncoder. I'm not sure if that's for correctness or because Django gained support for new types after StandardJSONEncoder stabilized.
I think it could be useful to shed some light on this in the FAQ. Thanks!
Contributor guide
Research direction
Locate the project's FAQ and read the existing StandardJSONEncoder documentation, then compare its stated supported types with DjangoJSONEncoder. Update the FAQ to explain their relationship, why StandardJSONEncoder exists outside Django, and whether the narrower type support is intentional or historical.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100