issues: 1006588071
This data as json
| id | node_id | number | title | user | state | locked | assignee | milestone | comments | created_at | updated_at | closed_at | author_association | active_lock_reason | draft | pull_request | body | reactions | performed_via_github_app | state_reason | repo | type |
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| 1006588071 | I_kwDOAMm_X847_1Cn | 5816 | Link API docs to user guide and other examples | 1197350 | open | 0 | 3 | 2021-09-24T15:34:31Z | 2021-10-10T16:39:18Z | MEMBER | Noting down a comment by @danjonesocean on Twitter: https://twitter.com/DanJonesOcean/status/1441392596362874882
Our API docs are generated by the function docstrings, and these are usually the first thing users hit when they search for functions. However, these docstring uniformly lack examples, often leaving users stuck. I see two ways to mitigate this: - Add examples directly to the docstings (suggested by @jklymak) - Cross reference other examples from the user guide or other tutorials |
{
"url": "https://api.github.com/repos/pydata/xarray/issues/5816/reactions",
"total_count": 1,
"+1": 0,
"-1": 0,
"laugh": 0,
"hooray": 0,
"confused": 0,
"heart": 0,
"rocket": 0,
"eyes": 1
} |
13221727 | issue |