[CONPY-199] Embedded Sphinx autodocs reference lowercase "mariadb" with no qualifier Created: 2022-04-05  Updated: 2022-04-07

Status: Open
Project: MariaDB Connector/Python
Component/s: Documentation
Affects Version/s: None
Fix Version/s: None

Type: Bug Priority: Major
Reporter: Geoff Montee (Inactive) Assignee: Georg Richter
Resolution: Unresolved Votes: 0
Labels: None


 Description   

MariaDB Connector/Python's embedded Sphinx autodocs contain reference to lowercase "mariadb" with no qualifier. For example, see the descriptions of “apilevel”, “paramstyle”, and “threadsafety” in the following file in the repository:

.. data:: apilevel
 
    String constant stating the supported DB API level. The value for `mariadb` is
    ``2.0``.
 
.. data:: threadsafety
 
    Integer constant stating the level of thread safety. For `mariadb` the value is 1,
    which means threads can share the module but not the connection.
 
.. data:: paramstyle
 
    String constant stating the type of parameter marker. For `mariadb` the value is
    `qmark`. For compatibility reasons `mariadb` also supports the `format` and
    `pyformat` paramstyles with the limitation that they can't be mixed inside a SQL statement.

https://github.com/mariadb-corporation/mariadb-connector-python/blob/88dcf20ebcdaef0502e59a9cdf234f46e7706eaf/docs/_sources/module.rst.txt

The mariadb reference seems to refer to the mariadb python module, but it is unqualified. We should probably fix it by taking one of the following actions:

  • Replace "mariadb" with "mariadb python module"
  • Or replace "mariadb" with "MariaDB Connector/Python"

Generated at Thu Feb 08 03:30:59 UTC 2024 using Jira 8.20.16#820016-sha1:9d11dbea5f4be3d4cc21f03a88dd11d8c8687422.