Skip to content

Commit f8a0aff

Browse files
committed
Add HDFS section to API docs
1 parent c54302d commit f8a0aff

File tree

2 files changed

+11
-1
lines changed

2 files changed

+11
-1
lines changed

python/doc/source/api.rst

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -164,6 +164,16 @@ Input / Output and Shared Memory
164164
create_memory_map
165165
PythonFile
166166

167+
Filesystems
168+
-----------
169+
170+
.. autosummary::
171+
:toctree: generated/
172+
173+
hdfs.connect
174+
HadoopFilesystem
175+
LocalFilesystem
176+
167177
.. _api.ipc:
168178

169179
Interprocess Communication and Messaging

python/pyarrow/hdfs.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -126,7 +126,7 @@ def connect(host="default", port=0, user=None, kerb_ticket=None,
126126
127127
Returns
128128
-------
129-
client : HDFSClient
129+
filesystem : HadoopFilesystem
130130
"""
131131
fs = HadoopFilesystem(host=host, port=port, user=user,
132132
kerb_ticket=kerb_ticket, driver=driver)

0 commit comments

Comments
 (0)