diff options
author | Will McGugan <willmcgugan@gmail.com> | 2017-01-08 15:46:28 +0000 |
---|---|---|
committer | Will McGugan <willmcgugan@gmail.com> | 2017-01-08 15:46:28 +0000 |
commit | d2bd0ed2760978ba45123d689cb9474b846d77db (patch) | |
tree | 4848748773fc984cb9a13bc14a42e4e118212595 /fs | |
parent | c94b20c877f1f2ab190d7b1eae3ecc53b3a6d295 (diff) | |
download | pyfilesystem-git-d2bd0ed2760978ba45123d689cb9474b846d77db.tar.gz |
some doc fixes
Diffstat (limited to 'fs')
-rw-r--r-- | fs/appdirfs.py | 2 | ||||
-rw-r--r-- | fs/base.py | 8 | ||||
-rw-r--r-- | fs/httpfs.py | 2 | ||||
-rw-r--r-- | fs/opener.py | 2 | ||||
-rw-r--r-- | fs/rpcfs.py | 2 |
5 files changed, 8 insertions, 8 deletions
diff --git a/fs/appdirfs.py b/fs/appdirfs.py index 86d8082..071b48c 100644 --- a/fs/appdirfs.py +++ b/fs/appdirfs.py @@ -5,7 +5,7 @@ fs.appdirfs A collection of filesystems that map to application specific locations. These classes abstract away the different requirements for user data across platforms, -which vary in their conventions. They are all subclasses of :class:`fs.osfs.OSFS`, +which vary in their conventions. They are all subclasses of :class:`~fs.osfs.OSFS`, all that differs from `OSFS` is the constructor which detects the appropriate location given the name of the application, author name and other parameters. @@ -68,7 +68,7 @@ class DummyLock(object): def silence_fserrors(f, *args, **kwargs): - """Perform a function call and return ``None`` if an :class:`fs.errors.FSError` is thrown + """Perform a function call and return ``None`` if an :class:`~fs.errors.FSError` is thrown :param f: Function to call :param args: Parameters to f @@ -89,7 +89,7 @@ class NoDefaultMeta(object): class NullFile(object): """A NullFile is a file object that has no functionality. - Null files are returned by the :meth:`fs.base.FS.safeopen` method in FS objects when the + Null files are returned by the :meth:`~fs.base.FS.safeopen` method in FS objects when the file doesn't exist. This can simplify code by negating the need to check if a file exists, or handling exceptions. @@ -589,9 +589,9 @@ class FS(object): files_only=False): """Generator yielding the files and directories under a given path. - This method behaves identically to :py:meth:`fs.base.FS.listdir` but returns an generator + 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 - 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. """ return iter(self.listdir(path, diff --git a/fs/httpfs.py b/fs/httpfs.py index 65514f4..9587394 100644 --- a/fs/httpfs.py +++ b/fs/httpfs.py @@ -21,7 +21,7 @@ class HTTPFS(FS): typical filesystem functionality. This class exists to allow the :doc:`opener` system to read files over HTTP. - If you do need filesystem like functionality over HTTP, see :mod:`fs.contrib.davfs`. + If you do need filesystem like functionality over HTTP, see :mod:`~fs.contrib.davfs`. """ diff --git a/fs/opener.py b/fs/opener.py index 6079226..e77b296 100644 --- a/fs/opener.py +++ b/fs/opener.py @@ -171,7 +171,7 @@ class OpenerRegistry(object): """Retrieve an opener for the given protocol :param name: name of the opener to open - :raises NoOpenerError: if no opener has been registered of that name + :raises `NoOpenerError`: if no opener has been registered of that name """ if name not in self.registry: diff --git a/fs/rpcfs.py b/fs/rpcfs.py index 00ba86a..15b6d3d 100644 --- a/fs/rpcfs.py +++ b/fs/rpcfs.py @@ -4,7 +4,7 @@ fs.rpcfs This module provides the class 'RPCFS' to access a remote FS object over XML-RPC. You probably want to use this in conjunction with the 'RPCFSServer' -class from the :mod:`fs.expose.xmlrpc` module. +class from the :mod:`~fs.expose.xmlrpc` module. """ |