- Documentation fixes

- removed COMMAND constants
mariadb-corporation · Apr 3, 2022 · 9ae99cd · 9ae99cd
1 parent 55ce15a
commit 9ae99cd
Show file tree

Hide file tree

Showing 4 changed files with 15 additions and 44 deletions.
diff --git a/mariadb/constants/CLIENT.py b/mariadb/constants/CLIENT.py
@@ -1,7 +1,10 @@
-''' MariaDB client flags
+''' 
+MariaDB client flags (internal use only).
 
 These flags are used when establishing a connection to a MariaDB
 database server or to check the capabilities of a MariaDB server.
+
+Client flags are defined in module *mariadb.constants.CLIENT_FLAG*
 '''
 
 MYSQL = 1  # MariaDB

diff --git a/mariadb/constants/COMMAND.py b/mariadb/constants/COMMAND.py
diff --git a/mariadb/constants/FIELD_FLAG.py b/mariadb/constants/FIELD_FLAG.py
@@ -1,7 +1,10 @@
 """MariaDB FIELD_FLAG Constants
 
-These constants represent the various field flags that are
-supported by MariaDB.
+These constants represent the various field flags. As an addition
+to the DBAPI 2.0 standard (PEP-249) these flags are returned as
+eigth element of the cursor description attribute.
+
+Field flags are defined in module *mariadb.constants.FIELD_FLAG*
 """
 
 # Source: mariadb_com.h (MariaDB Connector(C)

diff --git a/mariadb/constants/FIELD_TYPE.py b/mariadb/constants/FIELD_TYPE.py
@@ -1,10 +1,11 @@
-"""MariaDB FIELD_TYPE Constants
-
-These constants represent the various field types that are
-supported by MariaDB.
 """
+MariaDB FIELD_TYPE Constants
+
+These constants represent the field types supported by MariaDB.
+The field type is returned as second element of cursor description attribute.
 
-# Source: mariadb_com.h (MariaDB Connector(C)
+Field types are defined in module *mariadb.constants.FIELD_TYPE*
+"""
 
 DECIMAL = 0
 TINY = 1