Improved documentation (and fixed copy paste error)

lcosmin · Jul 21, 2015 · cdab6c7 · cdab6c7
1 parent d2d08b4
commit cdab6c7
Show file tree

Hide file tree

Showing 2 changed files with 13 additions and 7 deletions.
diff --git a/boardgamegeek/things.py b/boardgamegeek/things.py
@@ -1,9 +1,9 @@
 # coding: utf-8
 """
-:mod:`boardgamegeek.user` - Generic objects
-===========================================
+:mod:`boardgamegeek.things` - Generic objects
+=============================================
 
-.. module:: boardgamegeek.user
+.. module:: boardgamegeek.things
    :platform: Unix, Windows
    :synopsis: Generic objects
 
@@ -18,7 +18,7 @@
 
 class Thing(DictObject):
     """
-    A thing, an object with a name and an id
+    A thing, an object with a name and an id. Base class for various objects in the library.
     """
     def __init__(self, data):
         for i in ["id", "name"]:
@@ -41,4 +41,4 @@ def id(self):
         return self._data["id"]
 
     def __repr__(self):
-        return "Thing (id: {})".format(self.id)
+        return "Thing (id: {})".format(self.id)
diff --git a/docs/modules.rst b/docs/modules.rst
@@ -21,7 +21,6 @@ Modules
 .. automodule:: boardgamegeek.games
     :members:
 
-
 .. automodule:: boardgamegeek.guild
     :members:
     :undoc-members:
@@ -34,11 +33,18 @@ Modules
     :members:
     :undoc-members:
 
+.. automodule:: boardgamegeek.search
+    :members:
+    :undoc-members:
+
 .. automodule:: boardgamegeek.things
     :members:
     :undoc-members:
 
-.. automodule:: boardgamegeek.utils
+.. automodule:: boardgamegeek.user
     :members:
     :undoc-members:
 
+.. automodule:: boardgamegeek.utils
+    :members:
+    :undoc-members: