Commit 8cc2be2e by willmcgugan

Some doc changes

parent 71df3fdc
...@@ -35,6 +35,7 @@ Code Documentation ...@@ -35,6 +35,7 @@ Code Documentation
browsewin.rst browsewin.rst
errors.rst errors.rst
expose/index.rst expose/index.rst
filelike.rst
ftpfs.rst ftpfs.rst
memoryfs.rst memoryfs.rst
mountfs.rst mountfs.rst
......
...@@ -498,9 +498,9 @@ class FS(object): ...@@ -498,9 +498,9 @@ class FS(object):
absolute=False, absolute=False,
dirs_only=False, dirs_only=False,
files_only=False): files_only=False):
"""Iterator yielding the files and directories under a given path. """Generator yielding the files and directories under a given path.
This method behaves identically to :py:meth:`fs.base.FS.listdir` but returns an iterator This method behaves identically to :py:meth:`fs.base.FS.listdir` but returns an generator
instead of a list. Depending on the filesystem this may be more instead of a list. Depending on the filesystem this may be more
efficient than calling :py:meth:`fs.base.FS.listdir` and iterating over the resulting list. efficient than calling :py:meth:`fs.base.FS.listdir` and iterating over the resulting list.
...@@ -518,9 +518,9 @@ class FS(object): ...@@ -518,9 +518,9 @@ class FS(object):
absolute=False, absolute=False,
dirs_only=False, dirs_only=False,
files_only=False): files_only=False):
"""Iterator yielding paths and path info under a given path. """Generator yielding paths and path info under a given path.
This method behaves identically to :py:meth:`~fs.base.listdirinfo` but returns an iterator This method behaves identically to :py:meth:`~fs.base.listdirinfo` but returns an generator
instead of a list. Depending on the filesystem this may be more instead of a list. Depending on the filesystem this may be more
efficient than calling :py:meth:`~fs.base.listdirinfo` and iterating over the resulting efficient than calling :py:meth:`~fs.base.listdirinfo` and iterating over the resulting
list. list.
......
...@@ -83,14 +83,14 @@ class ZipFS(FS): ...@@ -83,14 +83,14 @@ class ZipFS(FS):
def __init__(self, zip_file, mode="r", compression="deflated", allow_zip_64=False, encoding="CP437", thread_synchronize=True): def __init__(self, zip_file, mode="r", compression="deflated", allow_zip_64=False, encoding="CP437", thread_synchronize=True):
"""Create a FS that maps on to a zip file. """Create a FS that maps on to a zip file.
:param zip_file: A (system) path, or a file-like object :param zip_file: a (system) path, or a file-like object
:param mode: Mode to open zip file: 'r' for reading, 'w' for writing or 'a' for appending :param mode: mode to open zip file: 'r' for reading, 'w' for writing or 'a' for appending
:param compression: Can be 'deflated' (default) to compress data or 'stored' to just store date :param compression: can be 'deflated' (default) to compress data or 'stored' to just store date
:param allow_zip_64: -- Set to True to use zip files greater than 2 GB, default is False :param allow_zip_64: set to True to use zip files greater than 2 GB, default is False
:param encoding: -- The encoding to use for unicode filenames :param encoding: the encoding to use for unicode filenames
:param thread_synchronize: -- Set to True (default) to enable thread-safety :param thread_synchronize: set to True (default) to enable thread-safety
:raises ZipOpenError: Thrown when the zip file could not be opened :raises :py:class:`fs.errrors.ZipOpenError`: thrown when the zip file could not be opened
:raises ZipNotFoundError: Thrown when the zip file does not exist (derived from ZipOpenError) :raises :py:class:`fs.errors.ZipNotFoundError`: thrown when the zip file does not exist (derived from ZipOpenError)
""" """
super(ZipFS, self).__init__(thread_synchronize=thread_synchronize) super(ZipFS, self).__init__(thread_synchronize=thread_synchronize)
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment