nteract / bookstore

📚 Notebook storage and publishing workflows for the masses
https://bookstore.readthedocs.io
BSD 3-Clause "New" or "Revised" License
201 stars 23 forks source link

Fixes client endpoints and adds docstrings #142

Closed mpacer closed 5 years ago

mpacer commented 5 years ago

As I was writing up the changelog, I realised we should be highlighting that in comparison to the rest of the library, these are experimental features that are not as well tested.

For instance, I realized that the current endpoints for bookstore did not match those that we actually provide as part of our API 🤦‍♀.

The changes to the endpoints are the only non-doc changes. If needed to get this ready to be merged in time for 2.3.0, I can break those out into a separate PR before we release: https://github.com/nteract/bookstore/pull/142/commits/80a9559f5a0d50175919f0dfda74dcdfa116d5bb

So I fixed that, and updated all of their docstrings to mention their experimental nature. I didn't do so for the records because we're actually testing those.

While I was at it I also improved the docstrings on the various class methods & modules.

codecov[bot] commented 5 years ago

Codecov Report

Merging #142 into master will not change coverage. The diff coverage is 33.33%.

@@           Coverage Diff           @@
##           master     #142   +/-   ##
=======================================
  Coverage   79.14%   79.14%           
=======================================
  Files          10       10           
  Lines         422      422           
=======================================
  Hits          334      334           
  Misses         88       88
codecov[bot] commented 5 years ago

Codecov Report

Merging #142 into master will not change coverage. The diff coverage is 33.33%.

@@           Coverage Diff           @@
##           master     #142   +/-   ##
=======================================
  Coverage   79.14%   79.14%           
=======================================
  Files          10       10           
  Lines         422      422           
=======================================
  Hits          334      334           
  Misses         88       88
mpacer commented 5 years ago

Grazie!