Commits

John Mulligan committed faa8598

improve spelling in docs

Comments (0)

Files changed (3)

doc/source/fsnix-fslib.rst

 
 This module exposes the lowest level functions and system calls.
 It it written in C and requires CPython 2.x compatible API to
-compile. If something here is underdocumented you should be able
+compile. If something here is under-documented you should be able
 to refer to the manpages on your system for details. Like the :mod:`os`
 module error codes are raised as exceptions with errno's assigned.
 
 Anywhere we can mimic the spirit of :mod:`os` we do, while at the
-same time trying to minimize deviations from the low level C-api.
+same time trying to minimize deviations from the low level C-API.
 
 
 Module API
 
 .. function:: mknodat(dirfd, pathname[, mode=0600][, device=0])
 
-    Create a filesystem node.
+    Create a file system node.
     Behaves in a manner similar to :func:`os.mknod`.
 
     If pathname is relative then the file will be created relative to
 
     These values correspond to a file system object type, except for 
     DT_UNKNOWN which indicates that the type could not be determined.
-    File systems that do not support d_type will always return DT_UNKOWN
+    File systems that do not support d_type will always return DT_UNKNOWN
     (equivalent to zero).
 
     The remaining values are for block devices, character devices,

doc/source/fsnix-util.rst

 ========================================
 
 .. module:: fsnix.util
-    :synopsis: Higher Level api using fslib calls
+    :synopsis: Higher Level API using fslib calls
 
 
 Module API
 
 .. function:: walk(top, topdown=True, onerror=None, followlinks=False, _fs=None)
 
-    An alternate implemenation of :func:`os.walk` which demonstrates
+    An alternate implementation of :func:`os.walk` which demonstrates
     the use of some of the lower level :mod:`fslib` functions.
 
     .. note:: *followlinks* is not supported by this function.
     Directory objects are intended to mimic the API of Python file objects
     to a limited degree. They are context managers and support the fileno
     method to get the file descriptor value. Instead of supporting IO
-    methods some simple dir listing wrappers are supported.
+    methods some simple directory listing wrappers are supported.
 
     .. attribute:: name
 

doc/source/index.rst

 one or more directory file descriptor and a relative path as arguments.
 This library also comes with custom directory listing functions that
 mimic os.listdir by default but can provide additional information
-(d_type) when passed a flag. Similarly, file discriptor and iterator
+(d_type) when passed a flag. Similarly, file descriptor and iterator
 based versions are also available.
 
 Additionally, this library provides a util module that has a higher level
 []
 
 
-This example shows how to create a subdir, write a file into that and then
-rename the directory, all using the low-level apis.
+This example shows how to create a subdirectory, write a file into that and
+then rename the directory, all using the low-level APIs.
 
 >>> import tempfile, os
 >>> from fsnix import fs
 ['foobar.txt']
 
 The util module aims at providing a higher level interface to make some
-common actions simpler. This example tries to wipe out any empty dirs
+common actions simpler. This example tries to wipe out any empty directories
 in the example directory.
 
 >>> import tempfile, os, errno
 Compatibility
 -------------
 
-The api for the POSIX.1-2008 `*at` functions should be compatible with the
+The API for the POSIX.1-2008 `*at` functions should be compatible with the
 functions that will be available in Python 3.3 and above,
 if said function is present in the posix module. If you use both and find
 differences, please let me know.
 
-The listdir-like functions should behave similarly to os.lisdir when
+The listdir-like functions should behave similarly to os.listdir when
 not passed any flags. The extended listdir calls are designed only to
 vary where appropriate.