docs: Document that the lineterminator defaults to the newline charac…

…ter, closes #669
wireservice · Oct 18, 2023 · 11ea63e · 11ea63e
1 parent 71211ad
commit 11ea63e
Showing 1 changed file with 3 additions and 1 deletion.
diff --git a/agate/table/to_csv.py b/agate/table/to_csv.py
@@ -6,7 +6,9 @@ def to_csv(self, path, **kwargs):
     Write this table to a CSV. This method uses agate's builtin CSV writer,
     which supports unicode on both Python 2 and Python 3.
 
-    `kwargs` will be passed through to the CSV writer.
+    ``kwargs`` will be passed through to the CSV writer.
+
+    The ``lineterminator`` defaults to the newline character (LF, ``\\n``).
 
     :param path:
         Filepath or file-like object to write to.