Commits

Fredrik Håård  committed a26f5e5

More doc updates

  • Participants
  • Parent commits 00f4e12

Comments (0)

Files changed (4)

File docs/hgapi.rst

 
 .. automodule:: hgapi.hgapi
     :members:
-    :show-inheritance:
+

File docs/index.rst

    hgapi
 
 
+
 Indices and tables
 ==================
 

File docs/setup.rst

-setup Module
-============
-
-.. automodule:: setup
-    :members:
-    :undoc-members:
-    :show-inheritance:

File hgapi/hgapi.py

 
 class Revision(object):
     """A representation of a revision.
-    Available fields are:
-        node, rev, author, branch, parents, date, tags, desc
-    A Revision object is equal to any other object 
-    with the same value for node
+    Available fields are::
+
+      node, rev, author, branch, parents, date, tags, desc
+
+    A Revision object is equal to any other object with the same value for node
     """
     def __init__(self, json_log):
         """Create a Revision object from a JSON representation"""
     def hg_status(self):
         """Get repository status.
         Returns a dict containing a *change char* -> *file list* mapping, where 
-        change char is in A, M, R, !, ?
+        change char is in::
 
-        Example - added one.txt, modified a_folder/two.txt and three.txt: 
-            {'A': ['one.txt'], 'M': ['a_folder/two.txt', 'three.txt'],
-            '!': [], '?': [], 'R': []}
+         A, M, R, !, ?
+
+        Example - added one.txt, modified a_folder/two.txt and three.txt::
+
+         {'A': ['one.txt'], 'M': ['a_folder/two.txt', 'three.txt'],
+         '!': [], '?': [], 'R': []}
         """
         cmds = ['status']
         out = self.hg_command(*cmds).strip()