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-566605273,https://api.github.com/repos/pydata/xarray/issues/3602,566605273,MDEyOklzc3VlQ29tbWVudDU2NjYwNTI3Mw==,14808389,2019-12-17T15:59:41Z,2019-12-17T16:45:18Z,MEMBER,"I renamed `from_store` to `load_store`, let's discuss both in #3638. For the injected / accessor methods there is #3625.","{""total_count"": 0, ""+1"": 0, ""-1"": 0, ""laugh"": 0, ""hooray"": 0, ""confused"": 0, ""heart"": 0, ""rocket"": 0, ""eyes"": 0}",,534329975
https://github.com/pydata/xarray/pull/3602#issuecomment-566640683,https://api.github.com/repos/pydata/xarray/issues/3602,566640683,MDEyOklzc3VlQ29tbWVudDU2NjY0MDY4Mw==,2448579,2019-12-17T16:29:58Z,2019-12-17T16:29:58Z,MEMBER,:clap: Welcome to xarray!,"{""total_count"": 1, ""+1"": 0, ""-1"": 0, ""laugh"": 0, ""hooray"": 1, ""confused"": 0, ""heart"": 0, ""rocket"": 0, ""eyes"": 0}",,534329975
https://github.com/pydata/xarray/pull/3602#issuecomment-566638161,https://api.github.com/repos/pydata/xarray/issues/3602,566638161,MDEyOklzc3VlQ29tbWVudDU2NjYzODE2MQ==,14808389,2019-12-17T16:24:09Z,2019-12-17T16:24:09Z,MEMBER,on it,"{""total_count"": 0, ""+1"": 0, ""-1"": 0, ""laugh"": 0, ""hooray"": 0, ""confused"": 0, ""heart"": 0, ""rocket"": 0, ""eyes"": 0}",,534329975
https://github.com/pydata/xarray/pull/3602#issuecomment-566637976,https://api.github.com/repos/pydata/xarray/issues/3602,566637976,MDEyOklzc3VlQ29tbWVudDU2NjYzNzk3Ng==,2448579,2019-12-17T16:23:48Z,2019-12-17T16:23:48Z,MEMBER,:+1: Wanna merge?,"{""total_count"": 0, ""+1"": 0, ""-1"": 0, ""laugh"": 0, ""hooray"": 0, ""confused"": 0, ""heart"": 0, ""rocket"": 0, ""eyes"": 0}",,534329975
https://github.com/pydata/xarray/pull/3602#issuecomment-566596626,https://api.github.com/repos/pydata/xarray/issues/3602,566596626,MDEyOklzc3VlQ29tbWVudDU2NjU5NjYyNg==,2448579,2019-12-17T15:41:20Z,2019-12-17T15:41:20Z,MEMBER,"> A grep over the code tells me that load_store is never used, tested or mentioned (from_store is mentioned but never defined or used): do we still support it?
I guess `from_store` mentions should be removed; let's open an issue for removing `load_store`. I don't know the backend code but it'd gone through multiple refactors so things may have been missed.
> dump_to_store is mentioned and tested, so we definitely should put it somewhere (even if it is just api-hidden.rst).
Let's stick this in `api-hidden.rst`
I think you should merge this after making these changes. It's a large step forward. We can revisit once someone comes up with a solution for the injected methods.","{""total_count"": 0, ""+1"": 0, ""-1"": 0, ""laugh"": 0, ""hooray"": 0, ""confused"": 0, ""heart"": 0, ""rocket"": 0, ""eyes"": 0}",,534329975
https://github.com/pydata/xarray/pull/3602#issuecomment-565830943,https://api.github.com/repos/pydata/xarray/issues/3602,565830943,MDEyOklzc3VlQ29tbWVudDU2NTgzMDk0Mw==,14808389,2019-12-15T17:51:05Z,2019-12-17T15:21:56Z,MEMBER,"I think once we decided what to do with the `DataStore` methods and how to treat the injected methods, we can merge?
Edit: I think we can just leave the accessor methods as is. This means we only have to decide what to do with `dump_to_store` and `load_store`. A grep over the code tells me that `load_store` is never used, tested or mentioned (`from_store` is mentioned but never defined or used): do we still support it? `dump_to_store` is mentioned and tested, so we definitely should put it somewhere (even if it is just `api-hidden.rst`).","{""total_count"": 0, ""+1"": 0, ""-1"": 0, ""laugh"": 0, ""hooray"": 0, ""confused"": 0, ""heart"": 0, ""rocket"": 0, ""eyes"": 0}",,534329975
https://github.com/pydata/xarray/pull/3602#issuecomment-565826169,https://api.github.com/repos/pydata/xarray/issues/3602,565826169,MDEyOklzc3VlQ29tbWVudDU2NTgyNjE2OQ==,14808389,2019-12-15T16:48:02Z,2019-12-15T16:48:02Z,MEMBER,"this is fairly close now:
```bash
grep -e ""doc/[^/]*.rst"" -e """" warnings
```
gives us
```
.../xarray/doc/generated/xarray.Dataset.rst:132::1: WARNING: py:obj reference target not found: xarray.Dataset.dump_to_store
.../xarray/doc/generated/xarray.Dataset.rst:132::1: WARNING: py:obj reference target not found: xarray.Dataset.load_store
.../xarray/doc/whats-new.rst:346: WARNING: py:meth reference target not found: Dataset.plot.scatter
.../xarray/doc/whats-new.rst:431: WARNING: py:meth reference target not found: Dataset.plot.scatter
.../xarray/doc/whats-new.rst:1068: WARNING: py:meth reference target not found: xarray.DataArray.plot.line
.../xarray/doc/whats-new.rst:1789: WARNING: py:meth reference target not found: DataArray.plot.imshow
```
which means only the injected methods and the `DataStore` related `Dataset` methods are left. If they are still supported, where should I put them?","{""total_count"": 0, ""+1"": 0, ""-1"": 0, ""laugh"": 0, ""hooray"": 0, ""confused"": 0, ""heart"": 0, ""rocket"": 0, ""eyes"": 0}",,534329975
https://github.com/pydata/xarray/pull/3602#issuecomment-565088059,https://api.github.com/repos/pydata/xarray/issues/3602,565088059,MDEyOklzc3VlQ29tbWVudDU2NTA4ODA1OQ==,14808389,2019-12-12T16:46:23Z,2019-12-12T16:46:23Z,MEMBER,"no, not yet. There are a lot of warnings left even if I leave out the ones due to the parameter type.","{""total_count"": 1, ""+1"": 1, ""-1"": 0, ""laugh"": 0, ""hooray"": 0, ""confused"": 0, ""heart"": 0, ""rocket"": 0, ""eyes"": 0}",,534329975
https://github.com/pydata/xarray/pull/3602#issuecomment-565087019,https://api.github.com/repos/pydata/xarray/issues/3602,565087019,MDEyOklzc3VlQ29tbWVudDU2NTA4NzAxOQ==,2448579,2019-12-12T16:43:48Z,2019-12-12T16:43:48Z,MEMBER,Is this ready to merge?,"{""total_count"": 0, ""+1"": 0, ""-1"": 0, ""laugh"": 0, ""hooray"": 0, ""confused"": 0, ""heart"": 0, ""rocket"": 0, ""eyes"": 0}",,534329975
https://github.com/pydata/xarray/pull/3602#issuecomment-564600809,https://api.github.com/repos/pydata/xarray/issues/3602,564600809,MDEyOklzc3VlQ29tbWVudDU2NDYwMDgwOQ==,2448579,2019-12-11T15:38:01Z,2019-12-11T15:38:01Z,MEMBER,"> The Data*Coordinates objects are returned by the coords attributes of DataArray and Dataset
Ah! I was wrong. These are public and have public methods that should be documented: see https://xarray.pydata.org/en/stable/data-structures.html#coordinates-methods","{""total_count"": 0, ""+1"": 0, ""-1"": 0, ""laugh"": 0, ""hooray"": 0, ""confused"": 0, ""heart"": 0, ""rocket"": 0, ""eyes"": 0}",,534329975
https://github.com/pydata/xarray/pull/3602#issuecomment-564335840,https://api.github.com/repos/pydata/xarray/issues/3602,564335840,MDEyOklzc3VlQ29tbWVudDU2NDMzNTg0MA==,14808389,2019-12-11T01:28:12Z,2019-12-11T01:28:12Z,MEMBER,"thanks for the review, @dcherian.
The `Data*Coordinates` objects are returned by the `coords` attributes of `DataArray` and `Dataset`. They are mostly treated as `dict` but they have a few public (i.e. not prefixed with an underscore) properties (e.g. `dims`), all of which don't have docstrings. I'll treat both classes as implementation detail.
Other than that, only the injection methods and the datastore methods remain for the manually written part. Unfortunately, the autodoc / autosummary warnings are due to a sphinx bug (see https://github.com/pydata/xarray/issues/3370#issuecomment-564124368), so our only option right now is to use `nitpicky_ignore` to silence them. I don't think we should, though. Instead, I'll try to silence all warnings that are not due to the bug and we can leave the rest to a potential round 4 or a sphinx / napoleon update.","{""total_count"": 0, ""+1"": 0, ""-1"": 0, ""laugh"": 0, ""hooray"": 0, ""confused"": 0, ""heart"": 0, ""rocket"": 0, ""eyes"": 0}",,534329975
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