home / github / issue_comments

Menu
  • Search all tables
  • GraphQL API

issue_comments: 563501747

This data as json

html_url issue_url id node_id user created_at updated_at author_association body reactions performed_via_github_app issue
https://github.com/pydata/xarray/pull/3602#issuecomment-563501747 https://api.github.com/repos/pydata/xarray/issues/3602 563501747 MDEyOklzc3VlQ29tbWVudDU2MzUwMTc0Nw== 14808389 2019-12-10T00:22:34Z 2019-12-10T23:30:11Z MEMBER

I added a lot of new entries to api-hidden.rst, mostly the methods of CFTimeIndex that were inherited from pandas.Index. Is that okay? sphinx also complains about the attributes (properties?) so I would probably need to add more.

Edit: I also added Data*Coarsen to api-hidden.rst, but we may want to think about giving them the same status as Data*Rolling or Data*Resample: put them into their own section in api.rst.


running sphinx-build with -w warnings and executing grep -e "doc/[^/]*.rst" warnings returns .../xarray/doc/whats-new.rst:336: WARNING: py:meth reference target not found: Dataset.plot.scatter .../xarray/doc/whats-new.rst:421: WARNING: py:meth reference target not found: Dataset.plot.scatter .../xarray/doc/whats-new.rst:468: WARNING: py:class reference target not found: xarray.core.coordinates.DataArrayCoordinates .../xarray/doc/whats-new.rst:1059: WARNING: py:meth reference target not found: xarray.DataArray.plot.line .../xarray/doc/whats-new.rst:1091: WARNING: py:meth reference target not found: xarray.tutorial.open_dataset .../xarray/doc/whats-new.rst:1091: WARNING: py:meth reference target not found: xarray.tutorial.load_dataset .../xarray/doc/whats-new.rst:1778: WARNING: py:meth reference target not found: DataArray.__dask_scheduler__ .../xarray/doc/whats-new.rst:1780: WARNING: py:meth reference target not found: DataArray.plot.imshow .../xarray/doc/whats-new.rst:1957: WARNING: py:func reference target not found: xarray.show_versions .../xarray/doc/whats-new.rst:2029: WARNING: py:meth reference target not found: xarray.backends.PydapDataStore.open these are the broken links in the non-autodoc / autosummary documentation: * if I remember correctly, scatter, line and imshow not having a documentation is known and the link will probably be fixed once we get sphinx to document what I think @dcherian called "injection methods". * I'd say __dask_scheduler__ is not part of the public API so we can convert to double-backtick quoted * DataArrayCoordinates and DatasetCoordinates still exist, but they are never referenced by the docs. Are they part of the public API? * show_versions does not have a docstring (which could be really small) and is not referenced elsewhere in the docs. What should I do with it? * the tutorial functions do have docstrings. Should we mention them somewhere else? * all the datastore documentation pages have broken links to their methods. Should I also add them to api-hidden.rst?

{
    "total_count": 0,
    "+1": 0,
    "-1": 0,
    "laugh": 0,
    "hooray": 0,
    "confused": 0,
    "heart": 0,
    "rocket": 0,
    "eyes": 0
}
  534329975
Powered by Datasette · Queries took 0.478ms · About: xarray-datasette