diff options
author | rfkelly0 <rfkelly0@67cdc799-7952-0410-af00-57a81ceafa0f> | 2011-03-08 02:13:50 +0000 |
---|---|---|
committer | rfkelly0 <rfkelly0@67cdc799-7952-0410-af00-57a81ceafa0f> | 2011-03-08 02:13:50 +0000 |
commit | 4506b3a8c72ed98b4cd7df78cd8dee21c766b803 (patch) | |
tree | 961d8b37decae53ac3e94e83f4e3024557799784 /docs | |
parent | d4eec36d06ad5227560eae8690397b612f5c657a (diff) | |
download | pyfilesystem-4506b3a8c72ed98b4cd7df78cd8dee21c766b803.tar.gz |
small doc tweaks
git-svn-id: http://pyfilesystem.googlecode.com/svn/trunk@650 67cdc799-7952-0410-af00-57a81ceafa0f
Diffstat (limited to 'docs')
-rw-r--r-- | docs/contrib.rst | 2 | ||||
-rw-r--r-- | docs/contrib/index.rst | 2 | ||||
-rw-r--r-- | docs/contrib/tahoefs.rst | 2 | ||||
-rw-r--r-- | docs/contrib/tahoelafs.rst | 2 | ||||
-rw-r--r-- | docs/implementersguide.rst | 4 | ||||
-rw-r--r-- | docs/introduction.rst | 2 |
6 files changed, 7 insertions, 7 deletions
diff --git a/docs/contrib.rst b/docs/contrib.rst index c2555d9..341c686 100644 --- a/docs/contrib.rst +++ b/docs/contrib.rst @@ -12,7 +12,7 @@ An interface to WebDAV file servers. See :mod:`fs.contrib.davfs` Tahoe LAFS ---------- -An interface to Tahoe Least-Authority File System. See :mod:`fs.contrib.tahoefs` +An interface to Tahoe Least-Authority File System. See :mod:`fs.contrib.tahoelafs` BIG (BIG Archive File Format) diff --git a/docs/contrib/index.rst b/docs/contrib/index.rst index 5879b8e..4d61f7b 100644 --- a/docs/contrib/index.rst +++ b/docs/contrib/index.rst @@ -7,6 +7,6 @@ The ``fs.contrib`` module contains a number of filesystem implementations provid :maxdepth: 3 davfs.rst - tahoefs.rst + tahoelafs.rst bigfs.rst diff --git a/docs/contrib/tahoefs.rst b/docs/contrib/tahoefs.rst deleted file mode 100644 index 61d5dd9..0000000 --- a/docs/contrib/tahoefs.rst +++ /dev/null @@ -1,2 +0,0 @@ -.. automodule:: fs.contrib.tahoefs - :members: diff --git a/docs/contrib/tahoelafs.rst b/docs/contrib/tahoelafs.rst new file mode 100644 index 0000000..57b2108 --- /dev/null +++ b/docs/contrib/tahoelafs.rst @@ -0,0 +1,2 @@ +.. automodule:: fs.contrib.tahoelafs + :members: diff --git a/docs/implementersguide.rst b/docs/implementersguide.rst index 2c59955..c7385fd 100644 --- a/docs/implementersguide.rst +++ b/docs/implementersguide.rst @@ -37,10 +37,10 @@ but there is nothing preventing you from implementing them -- just be careful to Filesystem Errors ----------------- -With the exception of the constuctor, FS methods should throw :class:`fs.errors.FSError` exceptions in preference to any specific exception classes, +With the exception of the constuctor, FS methods should throw :class:`fs.errors.FSError` exceptions in preference to any implementation-specific exception classes, so that generic exception handling can be written. The constructor *may* throw a non-FSError exception, if no appropriate FSError exists. -The rational for this is that creating an FS interface may require specific knowledge, +The rationale for this is that creating an FS interface may require specific knowledge, but this shouldn't prevent it from working with more generic code. If specific exceptions need to be translated in to an equivalent FSError, diff --git a/docs/introduction.rst b/docs/introduction.rst index dc6f58c..af2795b 100644 --- a/docs/introduction.rst +++ b/docs/introduction.rst @@ -3,7 +3,7 @@ Introduction PyFilesystem is a Python module that provides a common interface to any filesystem. -Think of PyFilesystem (FS) objects as the next logical step to Python's ``file`` class. Just as *file-like* objects abstract a single file, FS objects abstract the whole filesystem by providing a common interface to operations such as reading directories, getting file information, opening/copying/deleting files etc. +Think of PyFilesystem ``FS`` objects as the next logical step to Python's ``file`` class. Just as *file-like* objects abstract a single file, FS objects abstract the whole filesystem by providing a common interface to operations such as reading directories, getting file information, opening/copying/deleting files etc. Even if you only want to work with the local filesystem, PyFilesystem simplifies a number of common operations and reduces the chance of error. |