issues: 275049665

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
275049665 MDU6SXNzdWUyNzUwNDk2NjU= 1728 Tables in docs make looking up functions unnecessarily hard 7187503 closed 0     3 2017-11-18T03:31:49Z 2020-03-25T14:53:24Z 2020-03-25T14:53:24Z NONE      

Before anything else: I think xarray is awesome and I love using it! It has made my life so much simpler over juggling dictionaries of arrays and maintaining indices in my head. Thank you to all contributors 😄!

Problem description

I can't read the method tables all at once (i.e. method name + args + short description). This makes it unnecessarily hard to see which function is doing what. Here are some pictures using Firefox, with and without tree-style tabs, and on a larger monitor for the last one.

You have to scroll horizontally to read. This makes using a mouse terrible as the horizontal scrollbar is at the bottom of the table and not the bottom of the screen (the table is too big vertically to fit on the screen). The "hack" I'm using is to start selecting some text inside the table and drag the cursor to the edge leading to horizontal scrolling.

Suggestion

It would be nice if you didn't have tables but just inlined the short description like this one.

This allows text to wrap properly to the next line if needed. The only shortcoming is that the page takes up more vertical space but that's not such a big deal imo.

I'm happy to contribute a patch if someone can point me in the right direction. Is this a problem with sphinx_rtd_theme? I don't recall having similar issues with other packages' docs hosted on readthedocs.

 
{
    "url": "https://api.github.com/repos/pydata/xarray/issues/1728/reactions",
    "total_count": 0,
    "+1": 0,
    "-1": 0,
    "laugh": 0,
    "hooray": 0,
    "confused": 0,
    "heart": 0,
    "rocket": 0,
    "eyes": 0
}
   completed 13221727 issue

Links from other tables