try to get documentation up

This commit is contained in:
Philipp Moritz committed 2017-07-19 10:06:33 -07:00
1 parent 44d1a553d5
commit 327062801e
3 files changed
+24 -9

No files matched your search

+1 -1
View File
@@ -87,7 +87,7 @@ python_version_tests() {
}
# run tests for python 2.7 and 3.6
# python_version_tests 2.7
python_version_tests 2.7
python_version_tests 3.6
popd
+12
View File
@@ -212,6 +212,18 @@ Type Classes
Field
Schema
.. currentmodule:: pyarrow.plasma
.. _api.plasma:
In-Memory Object Store
----------------------
.. autosummary::
:toctree: generated/
PlasmaClient
.. currentmodule:: pyarrow.parquet
.. _api.parquet:
+11 -8
View File
@@ -218,15 +218,18 @@ cdef class PlasmaClient:
return result
def connect(self, store_socket_name, manager_socket_name, int release_delay):
"""Conect the PlasmaClient to a plasma store and optionally a manager.
"""
Conect the PlasmaClient to a plasma store and optionally a manager.
Args:
store_socket_name (str): Name of the socket the plasma store is
listening at.
manager_socket_name (str): Name of the socket the plasma manager is
listening at.
release_delay (int): The maximum number of objects that the client
will keep and delay releasing (for caching reasons).
Parameters
----------
store_socket_name : str
Name of the socket the plasma store is listening at.
manager_socket_name : str
Name of the socket the plasma manager is listening at.
release_delay : int
The maximum number of objects that the client will keep and
delay releasing (for caching reasons).
"""
cdef c_string store_sock_name = store_socket_name.encode()
cdef c_string manager_sock_name = manager_socket_name.encode()