Add note about recently discovered incompatibility in the Pandas tuto…

…rial.
BelgianBiodiversityPlatform · Aug 23, 2024 · 27008c6 · 27008c6
1 parent 118075b
commit 27008c6
Show file tree

Hide file tree

Showing 2 changed files with 5 additions and 6 deletions.
diff --git a/CHANGES.txt b/CHANGES.txt
@@ -1,9 +1,8 @@
-Current (unreleased)
+v0.16.1 (2024-08-23)
 --------------------
 
 - Added official support for Python 3.12
-- Proper error message when trying to use an unsupported combination of Pandas option
-and archives with default values (issue #106).
+- Proper error message when trying to use an unsupported combination of Pandas option and archives with default values (issue #106).
 
 v0.16.0 (2023-11-13)
 --------------------

diff --git a/doc/pandas_tutorial.rst b/doc/pandas_tutorial.rst
@@ -24,9 +24,9 @@ from the archive into a Pandas `DataFrame`_.
 .. note::
 
     :meth:`DwCAReader.pd_read` is a simple wrapper around
-    `pandas.read_csv() <https://pandas.pydata.org/pandas-docs/stable/generated/pandas.read_csv.html>`_ and accept the same
-    optional arguments. Only a few of them (`delimiter`, `skiprows`, `encoding`, ...) will be ignored because DwCAReader
-    sets them appropriately for the data file.
+    `pandas.read_csv() <https://pandas.pydata.org/pandas-docs/stable/generated/pandas.read_csv.html>`_ and accept the same optional arguments, with a few caveats:
+    1) Some of them (`delimiter`, `skiprows`, `encoding`, ...) will be ignored because DwCAReader sets them appropriately for the data file.
+    2) Some options of `pandas.read_csv()` make it returns a `TextFileReader` (`chunksize` or `iterator=True` for example). This should be avoided because it is incompatible with the Darwin Core Archives that make use of default values.
 
 .. note::