lincc-frameworks / lincc-frameworks/nested-pandas
Add a "why nested-pandas?" section to the docs
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 26
- Forks
- 8
- Avg merge
- 2d 2h
- Merged PRs (30d)
- 9
Description
Nested-Pandas is an enhancement to pandas that has some degree of overlap with other APIs (pandas multi-index, ragged arrays). It would be nice to have a section of the docs that explains the motivation behind nested-pandas and the strengths of it compared to the existing offerings for pandas users. Multi-indices is the main one (with our obvious strengths being that we can store an arbitrary number of columns at a given level with no data duplication, whereas multi-indices are limited to just using the index).
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 by locating the documentation structure and reading the existing sections about nested-pandas, pandas multi-indexes, and ragged arrays. Add a section explaining the motivation for nested-pandas and its strengths for pandas users, including arbitrary columns at a level and avoiding data duplication; done means the comparison is clear and complete.
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
- 55/100