#15 - fix documentation; changelog update

Author: pcisar

docs/changelog.txt

@@ -2,6 +2,12 @@
 Changelog
 #########
 
+Version 1.9.1 [Unreleased]
+==========================
+
+* Fix: #27 - Failed to establish a connection to the server on the specified port.
+* Fix: #15 - Documentation issue.
+
 Version 1.9.0
 =============
 

docs/python-db-api-compliance.txt

@@ -48,86 +48,16 @@ Nominally Supported Optional Features
         Although this method is present, it does nothing, as allowed by the spec.
 
 
-Extensions and Caveats
-======================
+Caveats
+=======
 
 Firebird-driver offers a large feature set beyond the minimal requirements
 of the Python DB API. This section attempts to document only those
-features that overlap with the DB API, or are too insignificant
-to warrant their own subsection elsewhere.
+features that overlap with the DB API.
 
 
-`.connect`
-
-   This function supports the following optional keyword arguments in addition
-   to those required by the spec:
-
-   :role:  For connecting to a database with a specific SQL role.
-
-   *Example:*
-
-   .. sourcecode:: python
-
-      firebird.driver.connect(dsn='host:/path/database.db', user='limited_user', password='pass', role='MORE_POWERFUL_ROLE')
-
-   :charset:  For explicitly specifying the character set of the connection.
-              See Firebird Documentation for a list of available character sets, and
-              `Unicode Fields and Firebird-driver` section for information on handling
-              extended character sets with Firebird-driver.
-
-   *Example:*
-
-   .. sourcecode:: python
-
-      firebird.driver.connect(dsn='host:/path/database.db', user='sysdba', password='pass', charset='UTF8')
-
-   :sql_dialect:  The SQL dialect is feature for backward compatibility with Interbase® 5.5
-                  or earlier. The default dialect is `3` (the most featureful dialect, default
-                  for Firebird). If you want to connect to `legacy` databases, you must
-                  explicitly set this argument's value to `1`. Dialect `2` is a transitional
-                  dialect that is normally used only during ports from IB < 6 to IB >= 6
-                  or Firebird. See Firebird documentation for more information about
-                  SQL Dialects.
-
-   *Example:*
-
-   .. sourcecode:: python
-
-      firebird.driver.connect(dsn='host:/path/database.db', user='sysdba', password='pass', dialect=1)
-
 `.Connection`
 
-   `~.Connection.charset`
-
-      *(read-only)* The character set of the connection (set via the `charset`
-      parameter of `.connect()`). See Firebird Documentation for a list
-      of available character sets, and `Unicode Fields and Firebird-driver` section
-      for information on handling extended character sets with Firebird-driver.
-
-   `~.Connection.sql_dialect`
-
-      This integer attribute indicates which SQL dialect the connection is using.
-      You should not change a connection's dialect; instead, discard the connection
-      and establish a new one with the desired dialect. For more information, see
-      the documentation of the `sql_dialect` argument of the `connect` function.
-
-   `~.Connection.server_version`
-
-      *(read-only)* The version string of the database server to which this connection
-      is connected.
-
-   `~.Connection.execute_immediate`
-
-      Executes a statement without caching its prepared form. The statement must *not* be
-      of a type that returns a result set. In most cases (especially cases in which the same
-      statement -- perhaps a parameterized statement -- is executed repeatedly),
-      it is better to create a cursor using the connection's `cursor` method, then execute
-      the statement using one of the cursor's execute methods.
-
-      Arguments:
-
-      :sql:  String containing the SQL statement to execute.
-
    `~.Connection.commit(retaining=False)`
    `~.Connection.rollback(retaining=False, savepoint=None)`
 
@@ -197,13 +127,3 @@ to warrant their own subsection elsewhere.
       .. note::
 
          This attribute is just an alias for `.Cursor.affected_rows` property.
-
-   `~.Cursor.fetchone`
-
-   `~.Cursor.fetchmany`
-
-   `~.Cursor.fetchall`
-
-      Firebird-driver makes absolutely no guarantees about
-      the return value of the `fetchone` / `fetchmany` / `fetchall` methods
-      except that it is a sequence indexed by field position.