split out large docs pages: Plotting, Reading and Writing Files
Open
Nobody has claimed this yet.
contrib-good-first-issue
contrib-help-wanted
enhancement
topic-documentation
- Dominant language
- Python
- Stars
- 4.2k
- Forks
- 1.4k
- Avg merge
- 2d 15h
- Merged PRs (30d)
- 14
Description
Is your feature request related to a problem?
The "Plotting" and "Reading and Writing Files" pages are quite long.
Now that we are on pydata-sphinx-theme it would be good to split them out, and make the material more discoverable.
Describe the solution you'd like
I propose:
- we split
io.rstinto three different files: netCDF/HDF; Zarr; and Others. - we splitting
plotting.rstto: "Lines", "2D Plots", "Scatter, Quiver, & Streamplot", Faceting
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
Read the existing io.rst and plotting.rst pages linked in the issue, starting with their current section structure. Split the material into the proposed netCDF/HDF, Zarr, Others, Lines, 2D Plots, Scatter/Quiver/Streamplot, and Faceting pages, and confirm the resulting documentation is easier to discover.
Written by the indexing model from the issue text.
Assessment
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Clearly specified
- Newbie friendliness
- 52/100