issues: 1620573171
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 |
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| 1620573171 | I_kwDOAMm_X85gl_vz | 7617 | The documentation contains some non-descriptive link texts. | 51911758 | closed | 0 | 4 | 2023-03-13T00:34:09Z | 2023-03-27T21:37:21Z | 2023-03-27T21:37:20Z | CONTRIBUTOR | What is your issue?I've been going through the docs and noticed some links could be more descriptive. Here are a few examples with options on how we could rewrite them: - See the user guide for more. -> Check out the indexing section in the user guide for a detailed explanation. - For more, see the Xarray documentation. -> See the documentation on automatic alignment to learn more. - This tutorial notebook also covers alignment and broadcasting (highly recommended)-> You can also check out this tutorial notebook on alignment and broadcasting (highly recommended). - For more see the user guide, the gallery, and the tutorial material. -> For more information, check out the following resources: * The plotting documentation in the user guide. * The visualization gallery. * The plotting and visualization tutorial materials. With more specific link texts, you get a clearer idea of what to expect when you click on the link which improves the reading experience. It also makes the links more accessible. |
{
"url": "https://api.github.com/repos/pydata/xarray/issues/7617/reactions",
"total_count": 1,
"+1": 1,
"-1": 0,
"laugh": 0,
"hooray": 0,
"confused": 0,
"heart": 0,
"rocket": 0,
"eyes": 0
} |
completed | 13221727 | issue |