Docs enhancements
Open
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 2.2k
- Forks
- 86
- PR merge metrics
- No merged PRs in 30d
Description
- Iter() reference Auto(list) as another option?
- public docs for Fill
- public docs explaining a "Mode" (not just for extending glom, but also for users, maybe part of a tutorial?)
- mark glom.Glommer() as deprecated (still a useful interface to targetregistry)
- public docs for Group (might be helpful to explain as a combination of Iter and Flatten)
- data-as-code after the tutorial? this goes with Mode; explaining glom's purpose is to leverage python's great literal syntax to be able to express many different things
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
Review the existing public documentation and tutorial against the checklist for Iter, Fill, Mode, Glommer, Group, and data-as-code; no specific files are named in the issue. Done means the selected documentation enhancements are added, the Glommer deprecation is marked, and the Mode and data-as-code concepts are explained for users.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 35/100