docs

xxxspy · Nov 30, 2015 · d8ac32c · d8ac32c
1 parent 578288a
commit d8ac32c
Show file tree

Hide file tree

Showing 4 changed files with 12 additions and 9 deletions.
diff --git a/docs/command_line.rst b/docs/command_line.rst
@@ -3,7 +3,7 @@
 Command Line Client
 ===================
 
-xlwings (from v0.6.0) comes with a command line client that allows an easy handling of template and add-in.
+xlwings (>=v0.6.0) comes with a command line client that allows an easy handling of template and add-in.
 On Windows, type the commands into a ``command prompt``, on Mac, type them into a ``Terminal``.
 
 

diff --git a/docs/udfs.rst b/docs/udfs.rst
@@ -3,7 +3,7 @@
 User Defined Functions (UDFs)
 =============================
 
-.. note:: This functionality is currently available on Windows only.
+.. note:: This functionality is currently only available on Windows.
 
 Installation of Excel Add-in (Recommended)
 ------------------------------------------

diff --git a/docs/vba.rst b/docs/vba.rst
@@ -20,10 +20,9 @@ If you don't know the location of your xlwings installation, you can find it as
     >>> xlwings.__path__
 
 An even easier way is to start from a template that already includes the xlwings VBA module and
-boilerplate code:
+boilerplate code. Use the command line client like this (for details see: :ref:`command_line`)::
 
-    >>> from xlwings import Workbook
-    >>> Workbook.open_template()
+    $ xlwings template open
 
 .. _vba_settings:
 
@@ -37,6 +36,7 @@ under ``Function Settings``::
     PYTHON_MAC = ""
     PYTHON_FROZEN = ThisWorkbook.Path & "\build\exe.win32-2.7"
     PYTHONPATH = ThisWorkbook.Path
+    UDF_PATH = ""
     LOG_FILE = ThisWorkbook.Path & "\xlwings_log.txt"
     SHOW_LOG = True
     OPTIMIZED_CONNECTION = False
@@ -50,6 +50,9 @@ under ``Function Settings``::
 * ``PYTHON_FROZEN`` [Optional]: Currently only on Windows, indicates the directory of the exe file that has been frozen
   by either using ``cx_Freeze`` or ``py2exe``. Can be set to ``""`` if unused.
 * ``PYTHONPATH`` [Optional]: If the source file of your code is not found, add the path here. Otherwise set it to ``""``.
+* ``UDF_PATH`` [Optional, Windows only]: Full path to a Python file from which the User Defined Functions are being imported.
+  Example: ``UDF_PATH = ThisWorkbook.Path & "\functions.py"``
+  Default: ``UDF_PATH = ""`` defaults to a file in the same directory of the Excel spreadsheet with the same name but ending in ``.py``.
 * ``LOG_FILE``: Directory **including** the file name. This file is necessary for error handling.
 * ``SHOW_LOG``: If False, no pop-up with the Log messages (usually errors) will be shown. Use with care.
 * ``OPTIMIZED_CONNECTION``: Currently only on Windows, use a COM Server for an efficient connection (experimental!)
@@ -102,6 +105,6 @@ This essentially hands over control to ``mymodule.py``:
 
 You can then attach ``MyMacro`` to a button or run it directly in the VBA Editor by hitting ``F5``.
 
-.. note:: Always place ``Workbook.caller()`` within the function that is called from Excel and not outside as
-    module-wide global variable. Otherwise it doesn't get garbage collected with ``OPTIMIZED_CONNECTION = True``
-    which prevents Excel from shutting down properly upon exiting and and leaves you with a zombie process.
+.. note:: Always place ``Workbook.caller()`` within the function that is being called from Excel and not outside as
+    global variable. Otherwise it prevents Excel from shutting down properly upon exiting and
+    leaves you with a zombie process when you use ``OPTIMIZED_CONNECTION = True``.
diff --git a/xlwings/xlwings.bas b/xlwings/xlwings.bas
@@ -34,7 +34,7 @@ Function Settings(ByRef PYTHON_WIN As String, ByRef PYTHON_MAC As String, ByRef
     ' PYTHON_FROZEN [Optional]: Currently only on Windows, indicate directory of exe file
     ' PYTHONPATH [Optional]: If the source file of your code is not found, add the path here.
     '                        Separate multiple directories by ";". Otherwise set to "".
-    ' UDF_PATH [Optional, Windows only]: Full path to a Python file from wich the User Defined Functions are being imported.
+    ' UDF_PATH [Optional, Windows only]: Full path to a Python file from which the User Defined Functions are being imported.
     '                                    Example: UDF_PATH = ThisWorkbook.Path & "\functions.py"
     '                                    Default: UDF_PATH = "" defaults to a file in the same directory of the Excel spreadsheet with
     '                                    the same name but ending in ".py".