From 3ba19dfe1e4dc04c801c11e983de0ea7041b3e4d Mon Sep 17 00:00:00 2001
From: Becky Smith <becky.smith@thedatalab.org>
Date: Thu, 15 Jun 2023 17:48:18 +0100
Subject: [PATCH] Update arrowload help file

---
 libraries/arrowload.sthlp | 26 ++++++++++++++++++++------
 1 file changed, 20 insertions(+), 6 deletions(-)

diff --git a/libraries/arrowload.sthlp b/libraries/arrowload.sthlp
index d2774f0..b69ab61 100644
--- a/libraries/arrowload.sthlp
+++ b/libraries/arrowload.sthlp
@@ -9,17 +9,26 @@ Syntax
 
         arrowload filename [, options]
 
-    options               Description
+    options                           Description
     ---------------------------------------------------------------------------------
     Main
       configfile(path/to/csv/file)    A csv file containing configuration for the import
+      verbosity(#)                    An integer to control the level of output;
+                                      default verbosity(3)
     ---------------------------------------------------------------------------------
 
 
 Description
 -----------
 
-    arrowload loads an arrow file
+    arrowload loads an arrow file into the stata dataset.
+
+    Columns in the arrow file are converted to the most appropriate stata variable type.
+
+    NOTE: Integer types will be loaded as byte, int or long, depending on the values of the
+    column in the arrow data. If the arrow data contains integers that are larger than 32 bit,
+    which cannot be represented as an integer in stata, the column will be loaded as a
+    string column, and values will be string representations of the integers.
 
 
 Options
@@ -35,10 +44,15 @@ Options
           long for use in stata. However, it is preferable fix the input file to use valid
           names. Some or all variable names can be mapped.
 
+    verbosity determine the level of output
+        - 1: prints minimal info messages
+        - 2: prints warnings only
+        - 3: prints all info messages (the default)
+
 
 Examples
 --------
-
-    . arrowload "/workspace/dataset.arrow"
-
-    . arrowload "/workspace/dataset.arrow", configfile("/workspace/config.csv")
+    . arrowload /workspace/dataset.arrow
+    . arrowload /workspace/dataset.arrow, verbosity(1)
+    . arrowload /workspace/dataset.arrow, configfile(/workspace/config.csv)
+    . arrowload /workspace/dataset.arrow, configfile(/workspace/config.csv) verbosity(2)