Commits

Anonymous committed 59dcdee

Change log files added.

Comments (0)

Files changed (6)

ChangeLog.txt

-Ver 2.5
-========
-
-Major update! QuickRef now supports both ST2 and ST3 from the same package.
-Changed where favourites data is stored to QuickRefData. Please copy your favourites over from the old file!
-
-Ver 2.1
-=======
-
-Rablador presents: QuickRef for Sublime Text 3!
-Note: The two versions of QuickRef are not interchangeable. You need the correct build for the version of Sublime Text that you are using.
-ST2: https://bitbucket.org/rablador/quickref
-ST3: https://bitbucket.org/rablador/quickref-st3
-
-New features (QuicRef for ST3)
-------------------------------
-All the features from QuickRef for Sublime Text 2 :).
-
-New features (QuicRef for ST2/ST3)
-----------------------------------
-Show update "splash" item in command list when QuickRef is updated.
-
-Ver 2.05
-========
-
-Announcement
-------------
-Working on a port for Sublime Text 3. Stay tuned!
-
-New features
-------------
-Favourites now being moved to the to of the list without "sort_alphabetically" set to "true".
-
-Ver 2.0
-=======
-
-Major release! Users may now filter out favourite commands right from the command palette.
-
-New features
-------------
-Add/remove favourites mode
-How to:
-1. Use a keyboard shortcut (eg. `alt+shift+p` on Windows) to bring up the QuickRef command palette in add/remove favourites mode.
-2. Simply select the command you want to mark and immediately see it get pefixed with a (*). If "Sort alphabetically" is on, all favourites will be displayed at the top of the list.
-
-Show favourites
-Show favourite commands in the QuickRef command palette. Favourites will be displayed at the top of the list with a prefixed (*).
-
-Error messages
-Now showing error messages when QuickRef is seriously misbehaving (no more guessing who's doing it wrong).
-
-Ver 1.6
-=======
-
-New features
-------------
-Command contexts
-Show contexts for commands. They will be displayed in parenthesis after a command.
-
-Remove duplicate contexts
-Remove commands with duplicate contexts and thereby reduce potentially superfluous items.
-
-Ver 1.5
-=======
-
-New features
-------------
-Beautify captions
-Beautify captions. E.g.: "clear_fields" -> "Clear fields". Great for users who don't want to add captions manually.
-
-User commands
-Choose whether to show or hide user added commands.
-
-User key bindings
-Choose whether to show or hide commands from the user bindings file.
-
-Default key bindings
-Choose whether to show or hide commands from the default bindings file.
-
-Remove duplicates
-When choosing to show commands from the default key bindings file, this feature removes duplicates.
-
-Shortcut key filter
-Filter out commands by shortcut keys.
-
-Bugs
-----
-Proper fix of bug from version 1.06.
-Fixed path not working in OSX (made QuickRef not start at all!).
-
-Ver 1.06
-========
-
-Temporarily fixed bug where missing setting in user's settings file results in QuickRef not loading. Proper fix in next update.
-
-Ver 1.05
-========
-
-Fixed bug that made alphabetical sorting not work as intended in all cases.
-Added setting to sort commands alphabetically or in the order that they are added to the settings file.
-
-Ver 1.0
-=======
-
-First release!

InThisVersion.txt

-Ver 2.5
-========
-
-Major update! QuickRef now supports both ST2 and ST3 from the same package.
-Changed where favourites data is stored to QuickRefData. Please copy your favourites over from the old file!
-
-
-
-=====
-For complete change log, see menu: Preferences -> Package Settings -> QuickRef -> Change Log
-For complete readme, see menu: Preferences -> Package Settings -> QuickRef -> ReadMe
   import Default
 
 class QuickRefCommand(sublime_plugin.ApplicationCommand):
+  """
+  Application command class for Sublime Text.
+  """
+
   def __init__(self):
+    """
+    Python init method.
+    """
     # Initialize list of commands. Needs to happen here since this value will 
     # determine whether to open or close the quick panel.
     self.command_list = None
     self.is_st2 = int(sublime.version()) < 3000
 
   def run(self, **kwargs):
+    """
+    Sublime Text main method.
+    """
     # Get paths.
     self.paths = self.get_paths()
 
         self.command_list = self.fav_command_list + self.command_list
         self.run_commands = self.fav_run_commands + self.run_commands
 
-        # @todo: Disabled for now.
-        # if os.path.exists(self.default_path + '/show_update_splash'):
-        #   self.command_list = [['- QuickRef has been updated!', '- Select to remove this item and see what\'s new.']] + self.command_list
-        #   self.run_commands = [['Show update']] + self.run_commands
-
         # Show quick panel with commands. Set a timeout to allow panel get ready before opening.
         sublime.set_timeout(lambda: self.window.show_quick_panel(self.command_list, self._on_select), 10)
       except Exception as e:
 
   def _add_favourites(self):
     """
-    Add favourites from favourites file.
+    Adds favourites from favourites file.
     """
     favourites = os.path.join(self.paths['user_data'], 'favourites.txt')
     if os.path.exists(favourites):
 
   def _add_user_commands(self):
     """
-    Add commands specified in QuickRef user settings.
+    Adds commands specified in QuickRef user settings.
     """
     # Parse commands from user settings file.
     user_commands = self.settings['commands']
 
   def _add_user_key_bindings(self):
     """
-    Add user specified key bindings.
+    Adds user specified key bindings.
     """
     # Load and parse commands from user keymap file.
     user_key_bindings_path = os.path.join(self.paths['user'], 'Default (' + self.platform + ').sublime-keymap')
 
   def _add_default_key_bindings(self):
     """
-    Add default key bindings.
+    Adds default key bindings.
     """
     # Load and parse commands from default keymap file.
     default_keymap = self.get_default_keymap()
 
   def _prepare_command(self, command, keys):
     """
-      Prepare commands for adding to command lists.
+    Prepares commands for adding to command lists.
     """
     # Check if command is a favourite.
     self.is_favourite = True if command['command'] + ',' + keys in self.favourites else False
 
   def _add_command(self, caption, command, keys, args, context):
     """
-    Add command to command lists.
+    Adds command to command lists.
     """
     # Add caption and keyboard shortcuts.
     list_item = [caption] + [keys]
 
   def _beautify_caption(self, command, sub_context):
     """
-    Make captions prettier.
+    Makes captions prettier.
     """
     if 'caption' in command:
       # Use supplied caption.
 
   def _on_select(self, idx):
     """
-    On list item selection.
+    Callback for quick panel selection, when selecting a command item.
     """
     # If command list has items and one was selected (index equals zero or more).
     if self.command_list and idx > -1:
-      # @todo: Disabled for now.
-      # # Show latest updates in new window.
-      # if 'Show update' == self.run_commands[idx][0]:
-      #   # Undefine command list in order to "reset" the plugin (see run()).
-      #   self.command_list = None
-      #   # Open file with latest changes from change log.
-      #   self.window.open_file(self.default_path + '/InThisVersion.txt', sublime.TRANSIENT)
-      #   # Remove splash control file to indicate that no splash should be shown.
-      #   os.remove(self.default_path + '/show_update_splash')
 
       # Add favourites to file.
       if not self.settings['regular_run_mode']:
 {
-  "install": "messages/install.txt"
+  "install": "messages/install.txt",
+  "1.0.5": "messages/1.0.5.txt",
+  "1.0.6": "messages/1.0.6.txt",
+  "1.5.0": "messages/1.5.0.txt",
+  "1.6.0": "messages/1.6.0.txt",
+  "2.0.0": "messages/2.0.0.txt",
+  "2.0.5": "messages/2.0.5.txt",
+  "2.1.0": "messages/2.1.0.txt",
+  "2.5.0": "messages/2.5.0.txt",
+  "2.5.1": "messages/2.5.1.txt"
 }

messages/install.txt

-sdsf
+Ver 1.0
+
+First release!

show_update_splash

-Delete me.