Merge pull request #2 from kimizhang/master

Add some documentation
Thriftpy · Jan 22, 2015 · 3ff8f00 · 3ff8f00
2 parents 094ac4d + 7c84740
commit 3ff8f00
Show file tree

Hide file tree

Showing 3 changed files with 8 additions and 2 deletions.
diff --git a/docs/source/errorhandling.rst b/docs/source/errorhandling.rst
@@ -22,6 +22,6 @@ In which,e is the Exception,f is the error handler,for example::
 
     app.register_error_handler(BasicException, BasicErrorHandler)
 
-The two arguments meta and result refers to :class:`~archer.app.ApiMeta` and :class:`~archer.app.ResultMeta`.
+The two arguments meta and result refers to :class:`~archer.app.ApiMeta` and :class:`~archer.app.ApiResultMeta`.
 
 Whenever a BasicException occurs,Archer will catch it and call BasicErrorHandler to handle it.
diff --git a/docs/source/event.rst b/docs/source/event.rst
@@ -13,5 +13,5 @@ before or after An api calling.
 
 Archer provides 3 events :data:`before_api_call`,  :data:`after_api_call`,
 :data:`tear_down_api_call`, all receive two arguments, first is instance of
-:class:`~archer.app.ApiMeta` and the second is instance of :class:`~archer.app.ResultMeta`.
+:class:`~archer.app.ApiMeta` and the second is instance of :class:`~archer.app.ApiResultMeta`.
 
diff --git a/docs/source/tutorial.rst b/docs/source/tutorial.rst
@@ -56,6 +56,12 @@ Now run call the remote function you can also use the :command:`archer` command:
 
 You should see that the string `pong` is returned
 
+
+You can also run a client shell by::
+
+    $ archer client
+    >>> client.ping()
+
 .. _public-server:
 
 .. admonition:: Externally Visible Server