updated docs

beautifultable/beautifultable.py

@@ -1,10 +1,10 @@
-"""The printer module contains Classes intended for printing Tabular data to terminals.
+"""This module provides BeautifulTable class intended for printing Tabular data to terminals.
 
 Example
 -------
->>> from printer_tools import BeautifulTable
+>>> from beautifultable import BeautifulTable
 >>> table = BeautifulTable()
->>> table.set_column_headers(['1st column', '2nd column'])
+>>> table.column_headers = ['1st column', '2nd column']
 >>> for i in range(5):
 ...    table.append_row([i, i*i])
 ...
@@ -94,14 +94,14 @@ def __setitem__(self, key, value):
 class TableMetaData(BaseRow):
     def __init__(self, table, row):
         for i in row:
-            self._validate(i)
+            self.validate(i)
         super().__init__(table, row)
 
     def __setitem__(self, key, value):
-        self._validate()
+        self.validate()
         super().__setitem__(key, value)
 
-    def _validate(self, value):
+    def validate(self, value):
         pass
 
 

docs/quickstart.rst

@@ -13,7 +13,7 @@ in the table. Let's create our first BeautifulTable.
 
    >>> from beautifultable import BeautifulTable
    >>> table = BeautifulTable()
-   >>> table.set_column_headers(["name", "rank", "gender"])
+   >>> table.column_headers = ["name", "rank", "gender"]
    >>> table.append_row(["Jacob", 1, "boy"])
    >>> table.append_row(["Isabella", 1, "girl"])
    >>> table.append_row(["Ethan", 2, "boy"])
@@ -73,7 +73,7 @@ But it retains the properties of the original object.
    |  Ethan   |  2   |  boy   | 2008 |
    +----------+------+--------+------+
 
-As you can see how easy it is to create a Table with TablePrinter.
+As you can see how easy it is to create a Table with BeautifulTable.
 Now lets move on to see some common use cases. Note that not all
 features are described here. See the API Documentation to get a
 detailed look at all the features.