From 5fa0916115faf55fb513161b4de0d9d8544bcbc2 Mon Sep 17 00:00:00 2001
From: Todd Leonhardt <todd.leonhardt@gmail.com>
Date: Thu, 9 Nov 2017 02:32:36 -0500
Subject: Updated docs to make it more clear that you need to update shortcuts
 attribute before calling super class __init__

---
 docs/index.rst          |  1 -
 docs/settingchanges.rst | 23 ++++++++++++++++++-----
 2 files changed, 18 insertions(+), 6 deletions(-)

(limited to 'docs')

diff --git a/docs/index.rst b/docs/index.rst
index dd410a44..3a52b9b5 100644
--- a/docs/index.rst
+++ b/docs/index.rst
@@ -48,7 +48,6 @@ Resources
 * `project bug tracker`_
 * Florida PyCon 2017: `slides <https://docs.google.com/presentation/d/1LRmpfBt3V-pYQfgQHdczf16F3hcXmhK83tl77R6IJtE>`_
 * PyOhio 2011: `video <https://archive.org/details/pyvideo_541___pyohio-2011-interactive-command-line-interpreters-with-cmd-and-cmd2>`_
-* PyCon 2010: `video <http://pyvideo.org/pycon-us-2010/pycon-2010--easy-command-line-applications-with-c.html>`_
 
 These docs will refer to ``App`` as your ``cmd2.Cmd``
 subclass, and ``app`` as an instance of ``App``.  Of
diff --git a/docs/settingchanges.rst b/docs/settingchanges.rst
index 326db3f5..0a24651b 100644
--- a/docs/settingchanges.rst
+++ b/docs/settingchanges.rst
@@ -19,11 +19,11 @@ Whether or not you set ``case_insensitive``, *please do not* define
 command method names with any uppercase letters.  ``cmd2`` expects all command methods
 to be lowercase.
 
-Shortcuts
-=========
+Shortcuts (command aliases)
+===========================
 
-Special-character shortcuts for common commands can make life more convenient for your
-users.  Shortcuts are used without a space separating them from their arguments,
+Command aliases for long command names such as special-character shortcuts for common commands can make life more
+convenient for your users.  Shortcuts are used without a space separating them from their arguments,
 like ``!ls``.  By default, the following shortcuts are defined:
 
   ``?``
@@ -42,7 +42,20 @@ To define more shortcuts, update the dict ``App.shortcuts`` with the
 {'shortcut': 'command_name'} (omit ``do_``)::
 
   class App(Cmd2):
-      Cmd2.shortcuts.update({'*': 'sneeze', '~': 'squirm'})
+      def __init__(self):
+        # Make sure you update the shortcuts attribute before calling the super class __init__
+        self.shortcuts.update({'*': 'sneeze', '~': 'squirm'})
+
+        # Make sure to call this super class __init__ after updating shortcuts
+        cmd2.Cmd.__init__(self)
+
+.. warning::
+
+  Command aliases needed to be created by updating the ``shortcuts`` dictionary attribute prior to calling the
+  ``cmd2.Cmd`` super class ``__init__()`` method.  Moreover, that super class init method needs to be called after
+  updating the ``shortcuts`` attribute  This warning applies in general to many other attributes which are not
+  settable at runtime such as ``commentGrammars``, ``multilineCommands``, etc.
+
 
 Default to shell
 ================
-- 
cgit v1.2.1