summaryrefslogtreecommitdiff
path: root/docs/interface.rst
diff options
context:
space:
mode:
authorwillmcgugan <willmcgugan@67cdc799-7952-0410-af00-57a81ceafa0f>2011-03-06 16:46:50 +0000
committerwillmcgugan <willmcgugan@67cdc799-7952-0410-af00-57a81ceafa0f>2011-03-06 16:46:50 +0000
commit06f917380c8add2ebe38c2c988e3dd197d3fcb78 (patch)
tree4b791362dc69af56c1a4bb0fe758abdd70f1f71f /docs/interface.rst
parent911a12eda532524d75c9468b8316887f32bd0cd9 (diff)
downloadpyfilesystem-06f917380c8add2ebe38c2c988e3dd197d3fcb78.tar.gz
More docs
git-svn-id: http://pyfilesystem.googlecode.com/svn/trunk@641 67cdc799-7952-0410-af00-57a81ceafa0f
Diffstat (limited to 'docs/interface.rst')
-rw-r--r--docs/interface.rst8
1 files changed, 7 insertions, 1 deletions
diff --git a/docs/interface.rst b/docs/interface.rst
index bf3ae9a..f39ed65 100644
--- a/docs/interface.rst
+++ b/docs/interface.rst
@@ -9,6 +9,8 @@ It may also be worthwhile implementing some of the non-essential methods, as the
If the filesystem you are implementing maps paths to the native filesystem, be sure to implement :py:meth:`~fs.base.FS.getsyspath`. Doing so will improve performance, especially when copying / moving files between FS objects.
+.. _essential-methods:
+
Essential Methods
-----------------
@@ -25,6 +27,8 @@ The following methods are required for a minimal Filesystem interface:
* :meth:`~fs.base.FS.getinfo` Return information about the path e.g. size, mtime
+.. _non-essential-methods:
+
Non - Essential Methods
-----------------------
@@ -46,10 +50,12 @@ The following methods have default implementations in :py:class:`fs.base.FS` and
* :meth:`~fs.base.FS.move` Move a file to a new location
* :meth:`~fs.base.FS.movedir` Recursively move a directory to a new location
* :meth:`~fs.base.FS.opendir` Opens a directory and returns an FS object that represents it
- * :meth:`~fs.base.FS.safeopen` Like :meth:`~fs.base.open` but returns a NullFile if the file could not be opened
+ * :meth:`~fs.base.FS.safeopen` Like :meth:`~fs.base.FS.open` but returns a :class:`~fs.base.NullFile` if the file could not be opened
* :meth:`~fs.base.FS.settimes` Sets the accessed and modified times of a path
+.. _utility-methods:
+
Utility Methods
---------------