search

CAVEconnectome / CAVEclient

This is the python client for accessing REST APIs within the Connectome Annotation Versioning Engine.
https://caveconnectome.github.io/CAVEclient/
MIT License
22 stars 11 forks source link

Doc updates #28

Closed fcollman closed 3 years ago

fcollman commented 3 years ago

I did some updating of the documentation to include the materialization. In the process I realized there were some features and changes that should make things easier and faster for the client.

I added a 'homepage' property to materialization in order to let people browse things that way.

I moved the recombination of columns to the client side, because there were major speed improvements in serialization and deserialization when passing uniform numpy arrays over the wire.

I made all the metadata objects return datetime converting objects, rather than leaving that to the user.

I also put in some example hyperlinks throughout the docs that bring the user to the function/class docstrings directly. We should use these more broadly.

fcollman commented 3 years ago

and look at that! caught my first bug with a test