Commit aa770bf1 by willmcgugan

Doc fixes

parent 8cc2be2e
...@@ -405,8 +405,8 @@ class FS(object): ...@@ -405,8 +405,8 @@ class FS(object):
:type files_only: bool :type files_only: bool
:rtype: iterable of paths :rtype: iterable of paths
:raises :py:class:`fs.errors.ResourceNotFoundError`: if the path is not found :raises `fs.errors.ResourceNotFoundError`: if the path is not found
:raises :py:class:`fs.errror.ResourceInvalidError`: if the path exists, but is not a directory :raises `fs.errror.ResourceInvalidError`: if the path exists, but is not a directory
""" """
raise UnsupportedError("list directory") raise UnsupportedError("list directory")
...@@ -434,8 +434,8 @@ class FS(object): ...@@ -434,8 +434,8 @@ class FS(object):
:param files_only: only retrieve files :param files_only: only retrieve files
:type files_only: bool :type files_only: bool
:raises :py:class:`fs.errors.ResourceNotFoundError`: If the path is not found :raises `fs.errors.ResourceNotFoundError`: If the path is not found
:raises :py:class:`ResourceInvalidError`: If the path exists, but is not a directory :raises `fs.errors.ResourceInvalidError`: If the path exists, but is not a directory
""" """
path = normpath(path) path = normpath(path)
...@@ -542,9 +542,9 @@ class FS(object): ...@@ -542,9 +542,9 @@ class FS(object):
:param allow_recreate: if True, re-creating a directory wont be an error :param allow_recreate: if True, re-creating a directory wont be an error
:type allow_create: bool :type allow_create: bool
:raises :py:class:`fs.errors.DestinationExistsError`: if the path is already a directory, and allow_recreate is False :raises `fs.errors.DestinationExistsError`: if the path is already a directory, and allow_recreate is False
:raises :py:class:`fs.errors.ParentDirectoryMissingError`: if a containing directory is missing and recursive is False :raises `fs.errors.ParentDirectoryMissingError`: if a containing directory is missing and recursive is False
:raises :py:class:`fs.errors.ResourceInvalidError`: if a path is an existing file :raises `fs.errors.ResourceInvalidError`: if a path is an existing file
""" """
raise UnsupportedError("make directory") raise UnsupportedError("make directory")
...@@ -554,8 +554,8 @@ class FS(object): ...@@ -554,8 +554,8 @@ class FS(object):
:param path: Path of the resource to remove :param path: Path of the resource to remove
:raises :py:class:`fs.errors.ResourceNotFoundError`: if the path does not exist :raises `fs.errors.ResourceNotFoundError`: if the path does not exist
:raises :py:class:`fs.errors.ResourceInvalidError`: if the path is a directory :raises `fs.errors.ResourceInvalidError`: if the path is a directory
""" """
raise UnsupportedError("remove resource") raise UnsupportedError("remove resource")
...@@ -569,9 +569,9 @@ class FS(object): ...@@ -569,9 +569,9 @@ class FS(object):
:param force: if True, any directory contents will be removed :param force: if True, any directory contents will be removed
:type force: bool :type force: bool
:raises :py:class:`fs.errors.ResourceNotFoundError`: if the path does not exist :raises `fs.errors.ResourceNotFoundError`: if the path does not exist
:raises :py:class:`fs.errors.ResourceInvalidError`: if the path is not a directory :raises `fs.errors.ResourceInvalidError`: if the path is not a directory
:raises :py:class:`fs.errors.DirectoryNotEmptyError:` if the directory is not empty and force is False :raises `fs.errors.DirectoryNotEmptyError`: if the directory is not empty and force is False
""" """
raise UnsupportedError("remove directory") raise UnsupportedError("remove directory")
......
...@@ -84,13 +84,13 @@ class ZipFS(FS): ...@@ -84,13 +84,13 @@ class ZipFS(FS):
"""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 :py:class:`fs.errrors.ZipOpenError`: thrown when the zip file could not be opened :raises `fs.errors.ZipOpenError`: thrown if the zip file could not be opened
:raises :py:class:`fs.errors.ZipNotFoundError`: thrown when the zip file does not exist (derived from ZipOpenError) :raises `fs.errors.ZipNotFoundError`: thrown if 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