diff options
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/commands.rst | 20 | ||||
| -rw-r--r-- | docs/concepts.rst | 2 | ||||
| -rw-r--r-- | docs/implementersguide.rst | 2 |
3 files changed, 12 insertions, 12 deletions
diff --git a/docs/commands.rst b/docs/commands.rst index 6ca1e84..9209ab8 100644 --- a/docs/commands.rst +++ b/docs/commands.rst @@ -42,7 +42,7 @@ Lists the contents of a directory, similar to the ``ls`` command, e.g.:: fstree ------ -Displays an ASCII tree of a directory. e.g:: +Displays an ASCII tree of a directory. e.g.:: fstree fstree -g @@ -52,7 +52,7 @@ Displays an ASCII tree of a directory. e.g:: fscat ----- -Writes a file to stdout, e.g:: +Writes a file to stdout, e.g.:: fscat ~/.bashrc fscat http://www.willmcgugan.com @@ -61,7 +61,7 @@ Writes a file to stdout, e.g:: fsinfo ------ -Displays information regarding a file / directory, e.g:: +Displays information regarding a file / directory, e.g.:: fsinfo C:\autoexec.bat fsinfo ftp://ftp.mozilla.org/pub/README @@ -69,7 +69,7 @@ Displays information regarding a file / directory, e.g:: fsmv ---- -Moves a file from one location to another, e.g:: +Moves a file from one location to another, e.g.:: fsmv foo bar fsmv *.jpg zip://photos.zip @@ -77,7 +77,7 @@ Moves a file from one location to another, e.g:: fsmkdir ------- -Makes a directory on a filesystem, e.g:: +Makes a directory on a filesystem, e.g.:: fsmkdir foo fsmkdir ftp://ftp.mozilla.org/foo @@ -86,7 +86,7 @@ Makes a directory on a filesystem, e.g:: fscp ---- -Copies a file from one location to another, e.g:: +Copies a file from one location to another, e.g.:: fscp foo bar fscp ftp://ftp.mozilla.org/pub/README readme.txt @@ -94,7 +94,7 @@ Copies a file from one location to another, e.g:: fsrm ---- -Removes (deletes) a file from a filesystem, e.g:: +Removes (deletes) a file from a filesystem, e.g.:: fsrm foo fsrm -r mydir @@ -102,7 +102,7 @@ Removes (deletes) a file from a filesystem, e.g:: fsserve ------- -Serves the contents of a filesystem over a network with one of a number of methods; HTTP, RPC or SFTP, e.g:: +Serves the contents of a filesystem over a network with one of a number of methods; HTTP, RPC or SFTP, e.g.:: fsserve fsserve --type rpc @@ -111,8 +111,8 @@ Serves the contents of a filesystem over a network with one of a number of metho fsmount ------- -Mounts a filesystem with FUSE (on Linux) and Dokan (on Windows), e.g:: +Mounts a filesystem with FUSE (on Linux) and Dokan (on Windows), e.g.:: fsmount mem:// ram fsserve mem:// M - fsserve ftp://ftp.mozilla.org/pub ftpgateway
\ No newline at end of file + fsserve ftp://ftp.mozilla.org/pub ftpgateway diff --git a/docs/concepts.rst b/docs/concepts.rst index 313ed04..dceaacd 100644 --- a/docs/concepts.rst +++ b/docs/concepts.rst @@ -45,7 +45,7 @@ PyFilesystem will catch any attempts to read outside of the root directory. For Paths ----- -Paths used within an FS object use the same common format, regardless of the underlaying file system it represents (or the platform it resides on). +Paths used within an FS object use the same common format, regardless of the underlying file system it represents (or the platform it resides on). When working with paths in FS objects, keep in mind the following: diff --git a/docs/implementersguide.rst b/docs/implementersguide.rst index ceac3a8..debdf71 100644 --- a/docs/implementersguide.rst +++ b/docs/implementersguide.rst @@ -62,7 +62,7 @@ Thread Safety All PyFilesystem methods, other than the constructor, should be thread-safe where-ever possible. One way to do this is to pass ``threads_synchronize=True`` to the base constructor and use the :func:`~fs.base.synchronize` decorator to lock the FS object when a method is called. -If the implementation can not be made thread-safe for technical reasons, ensure that ``getmeta("thread_safe")`` returns ``False``. +If the implementation cannot be made thread-safe for technical reasons, ensure that ``getmeta("thread_safe")`` returns ``False``. Meta Values |