Missing documentation for `init_with` and `encode_with`?
Open
Nobody has claimed this yet.
Documentation
- Dominant language
- Ruby
- Stars
- 597
- Forks
- 223
- Avg merge
- 11h 23m
- Merged PRs (30d)
- 3
Description
Looks like the main documentation is missing doc on how to (de)serialize custom classes by implementing init_with and encode_with.
Maybe @BurdetteLamar could help?
Contributor guide
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 by locating the main Psych documentation and existing references to init_with and encode_with. Document how custom classes use these methods for serialization and deserialization, then verify that both methods are covered clearly in the main documentation.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- ruby
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 38/100