Skip to content

Commit

Permalink
[ci skip] Update docstring
Browse files Browse the repository at this point in the history
  • Loading branch information
thombashi committed Apr 2, 2016
1 parent d8f6c08 commit 2fe6c58
Show file tree
Hide file tree
Showing 3 changed files with 126 additions and 149 deletions.
17 changes: 13 additions & 4 deletions simplesqlite/__init__.py
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@
def validate_table_name(name):
"""
:param str name: Table name to validate.
:raises ValueError: If ``name`` is invalid for a table name.
:raises ValueError: |raises_validate_table_name|
"""

if dataproperty.is_empty_string(name):
Expand All @@ -32,13 +32,14 @@ def append_table(con_src, con_dst, table_name):
:param SimpleSQLite con_src: Source of the database.
:param SimpleSQLite con_dst: Destination of the database.
:param str table_name: Table name to copy.
:return: ``True`` if success.
:return: |True| if success.
:rtype: bool
:raises simplesqlite.TableNotFoundError:
|raises_verify_table_existence|
:raises ValueError: If attribute of the table is different from each other.
.. seealso::
:py:meth:`simplesqlite.core.SimpleSQLite.verify_table_existence`
:py:meth:`simplesqlite.core.SimpleSQLite.create_table_with_data`
"""

Expand Down Expand Up @@ -70,7 +71,7 @@ def append_table(con_src, con_dst, table_name):

def connect_sqlite_db_mem():
"""
:return: Instance of a in memory database
:return: Instance of a in memory database.
:rtype: SimpleSQLite
:Examples:
Expand All @@ -97,8 +98,16 @@ class NullDatabaseConnectionError(Exception):


class TableNotFoundError(Exception):
"""
Raised when accessed the table that not exists in the database.
"""

pass


class AttributeNotFoundError(Exception):
"""
Raised when accessed the attribute that not exists in the table.
"""

pass
Loading

0 comments on commit 2fe6c58

Please sign in to comment.