Adding table module to autodoc sections.

dhermes · Jul 28, 2015 · 87f5300 · 87f5300
1 parent 8bfcf4e
commit 87f5300
Show file tree

Hide file tree

Showing 3 changed files with 10 additions and 1 deletion.
diff --git a/docs/index.rst b/docs/index.rst
@@ -159,6 +159,7 @@ Documented Modules
    table-connection
    client
    cluster
+   table
 
 Indices and tables
 ~~~~~~~~~~~~~~~~~~

diff --git a/docs/table.rst b/docs/table.rst
@@ -0,0 +1,7 @@
+Table
+~~~~~
+
+.. automodule:: gcloud_bigtable.table
+  :members:
+  :undoc-members:
+  :show-inheritance:
diff --git a/gcloud_bigtable/table.py b/gcloud_bigtable/table.py
@@ -83,11 +83,12 @@ def name(self):
         """Table name used in requests.
 
         .. note::
+
           This property will not change if ``table_id`` does not, but the
           return value is not cached.
 
         The table name is of the form
-        "projects/*/zones/*/clusters/*/tables/{table_id}"
+        "projects/../zones/../clusters/../tables/{table_id}"
 
         :rtype: string
         :returns: The table name.