pydata / pydata/xarray

'Cookbook' page

Open
#1,790 8 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

contrib-good-first-issue topic-documentation
Dominant language
Python
Stars
4.2k
Forks
1.4k
Avg merge
2d 15h
Merged PRs (30d)
14

Description

Would there be interest in adding a 'cookbook' section to the docs a-la Pandas? The current Recipes section might then be better renamed as Gallery?

It's useful for the kind of thing which isn't a full-fledged example, but might be useful nonetheless. I'll hapily put together a pull-request if there's interest.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by reviewing the current Recipes section and the linked Pandas cookbook for comparison. Clarify whether the proposal should add a cookbook, rename Recipes to Gallery, or both, and define the intended scope before beginning. Done means the documentation structure and scope are agreed and the resulting change is submitted as a pull request.

Written by the indexing model from the issue text.

Assessment

Tech stack
pandas, python
Domain
documentation
Issue type
Documentation
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.