How to document the format of a pandas DataFrame?
Open
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 355
- Forks
- 181
- Avg merge
- 1d 9h
- Merged PRs (30d)
- 3
Description
In an ETL project, a common pattern to pass pandas DataFrame objects from one method to another in order to enrich them with new columns. However, I'm struggling with finding a good format for how to document the columns and types of the input and output dataframes. Would love some discussion on how this is best accomplished. Thanks!
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
The issue names pandas DataFrame objects but no repository file, test, or entry point. First review numpydoc's existing documentation conventions and turn the discussion into a concrete proposal for documenting DataFrame columns and types; the issue currently does not define what completion would look like.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- pandas, python
- Domain
- data, documentation
- Issue type
- Documentation
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 25/100