diff options
| author | willmcgugan <willmcgugan@67cdc799-7952-0410-af00-57a81ceafa0f> | 2011-03-08 13:14:12 +0000 |
|---|---|---|
| committer | willmcgugan <willmcgugan@67cdc799-7952-0410-af00-57a81ceafa0f> | 2011-03-08 13:14:12 +0000 |
| commit | 87a17642fc50a8c2d1179218d5a4a15ccbdb90a0 (patch) | |
| tree | 2ae322d01eae86327b00df4cc6d8ccc563ce87a8 /docs | |
| parent | e84869530266409d47143fcc9b8cd1495d1469cd (diff) | |
| download | pyfilesystem-87a17642fc50a8c2d1179218d5a4a15ccbdb90a0.tar.gz | |
Corrections to the 'opening filesystems' doc
git-svn-id: http://pyfilesystem.googlecode.com/svn/trunk@654 67cdc799-7952-0410-af00-57a81ceafa0f
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/ftpfs.rst | 3 | ||||
| -rw-r--r-- | docs/opening.rst | 12 |
2 files changed, 9 insertions, 6 deletions
diff --git a/docs/ftpfs.rst b/docs/ftpfs.rst index 1164d78..a4b5c63 100644 --- a/docs/ftpfs.rst +++ b/docs/ftpfs.rst @@ -1,2 +1,5 @@ +fs.ftpfs +======== + .. autoclass:: fs.ftpfs.FTPFS :members:
\ No newline at end of file diff --git a/docs/opening.rst b/docs/opening.rst index d54e36f..0a0caf6 100644 --- a/docs/opening.rst +++ b/docs/opening.rst @@ -2,7 +2,7 @@ Opening Filesystems =================== Generally, when you want to work with the files and directories of any of the supported filesytems, -you create an instance of the appropriate class. For example, the following opens the directory /foo/bar:: +you create an instance of the appropriate class. For example, the following opens the directory ``/foo/bar``:: from fs.osfs import OSFS my_fs = OSFS('/foo/bar') @@ -12,14 +12,14 @@ However, there are occasions where the location of the files may change at runti In these situations you can use an *opener*, which is a generic way of specifying a filesystem. For example, the following is equivalent to the code above:: - from fs.opener import fsopen - my_fs = fsopen('/foo/bar') + from fs.opener import fsopendir + my_fs = fsopendir('/foo/bar') -The `fsopen` method takes a string that identifies the filesystem with a URI syntax, but if called with a regular path will return an OSFS instance. +The ``fsopendir`` callable takes a string that identifies the filesystem with a URI syntax, but if called with a regular path will return an :class:`~fs.osfs.OSFS` instance. To open a different kind of filesystem, precede the path with the required protocol. For example, the following code opens an FTP filesystem rather than a directory on your harddrive:: - from fs.opener import fsopen - my_fs = fsopen('ftp://example.org/foo/bar') + from fs.opener import fsopendir + my_fs = fsopendir('ftp://example.org/foo/bar') For further information regarding filesystem openers see :doc:`opener`.
\ No newline at end of file |