Uploaded image for project: 'MariaDB Connector/Python'
  1. MariaDB Connector/Python
  2. CONPY-199

Embedded Sphinx autodocs reference lowercase "mariadb" with no qualifier

    XMLWordPrintable

Details

    • Bug
    • Status: Open (View Workflow)
    • Major
    • Resolution: Unresolved
    • None
    • None
    • Documentation
    • 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"

      Attachments

        Activity

          People

            georg Georg Richter
            GeoffMontee Geoff Montee (Inactive)
            Votes:
            0 Vote for this issue
            Watchers:
            2 Start watching this issue

            Dates

              Created:
              Updated:

              Git Integration

                Error rendering 'com.xiplink.jira.git.jira_git_plugin:git-issue-webpanel'. Please contact your Jira administrators.