Adding upstream version 0.19.2.upstream/0.19.2upstream

Signed-off-by: Daniel Baumann <daniel.baumann@progress-linux.org>

1 files changed, 19 insertions, 0 deletions

diff --git a/doc/python/orcus/csv/index.rst b/doc/python/orcus/csv/index.rst
new file mode 100644
index 0000000..f2b73a0
--- /dev/null
+++ b/doc/python/orcus/csv/index.rst
@@ -0,0 +1,19 @@
+
+orcus.csv
+=========
+
+.. py:function:: orcus.csv.read
+
+   Read an CSV file from a specified file path and create a :py:class:`orcus.Document`
+   instance object.
+
+   :param stream: either string value, or file object containing a string stream.
+   :rtype: :py:class:`orcus.Document`
+   :return: document instance object that stores the content of the file.
+
+   Example::
+
+      from orcus import csv
+
+      with open("path/to/file.csv", "r") as f:
+          doc = csv.read(f)