From 974c0912f7b7bfaf2c9345c1ef79167c93a2c44f Mon Sep 17 00:00:00 2001
From: marcoslbueno <marcoslbueno@gmail.com>
Date: Fri, 10 Jul 2020 00:24:46 +0200
Subject: [PATCH 1/2] adding config file to user guide

---
 doc/usage.rst | 31 +++++++++++++++++++++++++++++++
 1 file changed, 31 insertions(+)

diff --git a/doc/usage.rst b/doc/usage.rst
index 36c8584ff..0a266e2b8 100644
--- a/doc/usage.rst
+++ b/doc/usage.rst
@@ -29,6 +29,37 @@ the OpenML Python connector, followed up by a simple example.
 
 * `Introduction <examples/introduction_tutorial.html>`_
 
+~~~~~~~~~~~~~
+Configuration
+~~~~~~~~~~~~~
+
+The configuration file resides in a directory ``.openml`` in the home
+directory of the user and is called config. It consists of ``key = value`` pairs
+which are separated by newlines. The following keys are defined:
+
+* apikey:
+    * required to access the server
+
+* server:
+    * default: ``http://www.openml.org``
+
+* cachedir:
+    * if not given, will default to ``file.path(tempdir(), "cache")``.
+
+* avoid_duplicate_runs:
+    * if not given, will default to ``True``.
+
+* connection_n_retries:
+    * default: 2. Maximum number of retries: 20.
+
+* verbosity:
+    * 0: normal output
+    * 1: info output
+    * 2: debug output
+
+* arff.reader:
+    * ``RWeka``: This is the standard Java parser used in Weka.
+    * ``farff``: The `farff package <http://www.github.com/mlr-org/farff>`_ lives below the mlr-org and is a newer, faster parser without Java.
 
 ~~~~~~~~~~~~
 Key concepts

From 6297ebd8aaaa116db6ba0d614cd4e06e62398c2b Mon Sep 17 00:00:00 2001
From: marcoslbueno <marcoslbueno@gmail.com>
Date: Sat, 11 Jul 2020 01:44:56 +0200
Subject: [PATCH 2/2] finished requested changes

---
 doc/usage.rst | 12 +++++-------
 1 file changed, 5 insertions(+), 7 deletions(-)

diff --git a/doc/usage.rst b/doc/usage.rst
index 0a266e2b8..d7ad0d523 100644
--- a/doc/usage.rst
+++ b/doc/usage.rst
@@ -38,18 +38,20 @@ directory of the user and is called config. It consists of ``key = value`` pairs
 which are separated by newlines. The following keys are defined:
 
 * apikey:
-    * required to access the server
+    * required to access the server. The `OpenML setup <https://openml.github.io/openml-python/master/examples/20_basic/introduction_tutorial.html#authentication>`_ describes how to obtain an API key.
 
 * server:
-    * default: ``http://www.openml.org``
+    * default: ``http://www.openml.org``. Alternatively, use ``test.openml.org`` for the test server.
 
 * cachedir:
-    * if not given, will default to ``file.path(tempdir(), "cache")``.
+    * if not given, will default to ``~/.openml/cache``
 
 * avoid_duplicate_runs:
+    * if set to ``True``, when ``run_flow_on_task`` or similar methods are called a lookup is performed to see if there already exists such a run on the server. If so, download those results instead.
     * if not given, will default to ``True``.
 
 * connection_n_retries:
+    * number of connection retries.
     * default: 2. Maximum number of retries: 20.
 
 * verbosity:
@@ -57,10 +59,6 @@ which are separated by newlines. The following keys are defined:
     * 1: info output
     * 2: debug output
 
-* arff.reader:
-    * ``RWeka``: This is the standard Java parser used in Weka.
-    * ``farff``: The `farff package <http://www.github.com/mlr-org/farff>`_ lives below the mlr-org and is a newer, faster parser without Java.
-
 ~~~~~~~~~~~~
 Key concepts
 ~~~~~~~~~~~~