Skip to content

Commit 9f5a43a

Browse files
committed
Documentation: Drop "compatibility notes" section
The compatibility tables would need structural rework in order to express the "phasing out" of support for specific software versions. I think it is safe to remove this section completely in order to reduce maintenance overhead.
1 parent cd91832 commit 9f5a43a

File tree

5 files changed

+3
-213
lines changed

5 files changed

+3
-213
lines changed

docs/appendices/compatibility.rst

Lines changed: 0 additions & 204 deletions
This file was deleted.

docs/appendices/index.rst

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,4 +12,3 @@ Supplementary information for the CrateDB Python client library.
1212
:maxdepth: 2
1313

1414
data-types
15-
compatibility

docs/connect.rst

Lines changed: 1 addition & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -14,8 +14,7 @@ Connect to CrateDB
1414
.. SEEALSO::
1515

1616
Supplementary information about the CrateDB Database API client can be found
17-
in the :ref:`data types appendix <data-types-db-api>` and the
18-
:ref:`compatibility notes <compatibility>`.
17+
in the :ref:`data types appendix <data-types-db-api>`.
1918

2019
For general help using the Database API, consult `PEP 0249`_.
2120

@@ -218,8 +217,6 @@ Authentication
218217
If you are using CrateDB 2.1.x or later, you must supply a username. If you
219218
are using earlier versions of CrateDB, this argument is not supported.
220219

221-
See the :ref:`compatibility notes <cratedb-versions>` for more information.
222-
223220
You can authenticate with CrateDB like so::
224221

225222
>>> connection = client.connect(..., username="<USERNAME>", password="<PASSWORD>")

docs/query.rst

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -14,8 +14,7 @@ Query CrateDB
1414
.. SEEALSO::
1515

1616
Supplementary information about the CrateDB Database API client can be found
17-
in the :ref:`data types appendix <data-types-db-api>` and the
18-
:ref:`compatibility notes <compatibility>`.
17+
in the :ref:`data types appendix <data-types-db-api>`.
1918

2019
For general help using the Database API, consult `PEP 0249`_.
2120

docs/sqlalchemy.rst

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -23,8 +23,7 @@ The CrateDB Python client library is validated to work with SQLAlchemy versions
2323
.. SEEALSO::
2424

2525
Supplementary information about the CrateDB SQLAlchemy dialect can be found
26-
in the :ref:`data types appendix <data-types-sqlalchemy>` and the
27-
:ref:`compatibility notes <compatibility>`.
26+
in the :ref:`data types appendix <data-types-sqlalchemy>`.
2827

2928
For general help using SQLAlchemy, consult the `SQLAlchemy tutorial`_ or the
3029
`SQLAlchemy library`_ .

0 commit comments

Comments
 (0)