misc. typos all over the place

git-svn-id: http://ncclient.googlecode.com/svn/trunk@152 6dbcf712-26ac-11de-a2f3-1373824ab735

diff --git a/docs/source/conf.py b/docs/source/conf.py
index 7987239..26235c1 100644 (file)
--- a/docs/source/conf.py
+++ b/docs/source/conf.py
@@ -45,7 +45,7 @@ license = 'APL'
 # The short X.Y version.
 version = '0.1'
 # The full version, including alpha/beta/rc tags.
-release = '0.1.1a'
+release = '0.1.0'
 
 # The language for content autogenerated by Sphinx. Refer to documentation
 # for a list of supported languages.

diff --git a/docs/source/intro.rst b/docs/source/intro.rst
index 97adc0e..491cdcc 100644 (file)
--- a/docs/source/intro.rst
+++ b/docs/source/intro.rst
@@ -18,11 +18,12 @@ The best way to introduce is of course, through a simple code example::
 
     from ncclient import manager
 
-    with manager.connect_ssh('host', 'username') as m:
+    # use ssh-agent or ~/.ssh keys for auth, load known_hosts by default
+    with manager.connect_ssh('host', username='username') as m:
         assert(":url" in manager.server_capabilities)
         with m.locked('running'):
             m.copy_config(source="running", target="file://new_checkpoint.conf")
             m.copy_config(source="file://old_checkpoint.conf", target="running")
 
-It is recommended to use the high-level :class:`Manager` API where possible. It exposes almost all of the functionality.
+It is recommended to use the high-level :class:`Manager` API where possible. It exposes all of the functionality except asynchronous RPC requests.
 

diff --git a/docs/source/userdoc/xml.rst b/docs/source/userdoc/xml.rst
index 8916687..047528f 100644 (file)
--- a/docs/source/userdoc/xml.rst
+++ b/docs/source/userdoc/xml.rst
@@ -1,5 +1,5 @@
 **********************
-:mod:`content` module
+:mod:`xml_` module
 **********************
 
 .. automodule:: ncclient.xml_

diff --git a/ncclient/manager.py b/ncclient/manager.py
index 2c45e22..a43eb4e 100644 (file)
--- a/ncclient/manager.py
+++ b/ncclient/manager.py
@@ -71,7 +71,7 @@ class Manager:
         if not reply.ok:
             if self._raise == RAISE_ALL:
                 raise reply.error
-            elif self._raise == RAISE_ERROR:
+            elif self._raise == RAISE_ERR:
                 for error in reply.errors:
                     if error.severity == 'error':
                         raise error

diff --git a/ncclient/operations/rpc.py b/ncclient/operations/rpc.py
index 006ba87..9142788 100644 (file)
--- a/ncclient/operations/rpc.py
+++ b/ncclient/operations/rpc.py
@@ -239,13 +239,13 @@ class RPC(object):
     taking delivery of the reply.
     """
 
-    # : Subclasses can specify their dependencies on capabilities. List of URI's
+    #: Subclasses can specify their dependencies on capabilities. List of URI's
     # or abbreviated names, e.g. ':writable-running'. These are verified at the
     # time of object creation. If the capability is not available, a
     # :exc:`MissingCapabilityError` is raised.
     DEPENDS = []
 
-    # : Subclasses can specify a different reply class, but it must be a
+    #: Subclasses can specify a different reply class, but it must be a
     # subclass of :class:`RPCReply`.
     REPLY_CLS = RPCReply
 
@@ -328,7 +328,8 @@ class RPC(object):
         :exc:`MissingCapabilityError` will be raised if the capability is not
         available."""
         if capability not in self._session.server_capabilities:
-            raise MissingCapabilityError('Server does not support [%s]' % cap)
+            raise MissingCapabilityError('Server does not support [%s]' %
+                                         capability)
 
     def deliver_reply(self, raw):
         # internal use

diff --git a/ncclient/operations/session.py b/ncclient/operations/session.py
index d954c88..acca887 100644 (file)
--- a/ncclient/operations/session.py
+++ b/ncclient/operations/session.py
@@ -26,7 +26,7 @@ class CloseSession(RPC):
 
     SPEC = { 'tag': 'close-session' }
 
-    def _delivsery_hook(self):
+    def _delivery_hook(self):
         self.session.close()
 
     def request(self):