From 728fb8385d3a4dca994ae652ca44b9ffe72a029d Mon Sep 17 00:00:00 2001
From: hut <hut@lavabit.com>
Date: Sun, 13 Dec 2009 00:45:03 +0100
Subject: added docstrings everywhere

---
 ranger/actions.py | 28 ++++++++++++++++++++++++++++
 1 file changed, 28 insertions(+)

(limited to 'ranger/actions.py')

diff --git a/ranger/actions.py b/ranger/actions.py
index a36b0c56..2435480b 100644
--- a/ranger/actions.py
+++ b/ranger/actions.py
@@ -2,16 +2,20 @@ from ranger.shared import EnvironmentAware, SettingsAware
 
 class Actions(EnvironmentAware, SettingsAware):
 	def search_forward(self):
+		"""Search forward for the regexp in self.env.last_search"""
 		if self.env.pwd:
 			if self.env.pwd.search(self.env.last_search):
 				self.env.cf = self.env.pwd.pointed_file
 
 	def search_backward(self):
+		"""Search backward for the regexp in self.env.last_search"""
 		if self.env.pwd:
 			if self.env.pwd.search(self.env.last_search, -1):
 				self.env.cf = self.env.pwd.pointed_file
 
 	def interrupt(self):
+		"""Waits a short time.
+If CTRL+C is pressed while waiting, the program will be exited"""
 		import time
 		self.env.key_clear()
 		try:
@@ -20,15 +24,19 @@ class Actions(EnvironmentAware, SettingsAware):
 			raise SystemExit()
 
 	def resize(self):
+		"""Update the size of the UI"""
 		self.ui.update_size()
 
 	def exit(self):
+		"""Exit the program"""
 		raise SystemExit()
 
 	def enter_dir(self, path):
+		"""Enter the directory at the given path"""
 		self.env.enter_dir(path)
 
 	def enter_bookmark(self, key):
+		"""Enter the bookmark with the name <key>"""
 		from ranger.container.bookmarks import NonexistantBookmark
 		try:
 			destination = self.bookmarks[key]
@@ -40,26 +48,38 @@ class Actions(EnvironmentAware, SettingsAware):
 			pass
 
 	def set_bookmark(self, key):
+		"""Set the bookmark with the name <key> to the current directory"""
 		self.bookmarks[key] = self.env.pwd.path
 
 	def unset_bookmark(self, key):
+		"""Delete the bookmark with the name <key>"""
 		self.bookmarks.delete(key)
 
 	def move_left(self):
+		"""Enter the parent directory"""
 		self.env.enter_dir('..')
 	
 	def move_right(self, mode = 0):
+		"""Enter the current directory or execute the current file"""
 		cf = self.env.cf
 		if not self.env.enter_dir(cf):
 			self.execute_file(cf, mode = mode)
 
 	def history_go(self, relative):
+		"""Move back and forth in the history"""
 		self.env.history_go(relative)
 	
 	def handle_mouse(self):
+		"""Handle mouse-buttons if one was pressed"""
 		self.ui.handle_mouse()
 
 	def execute_file(self, files, app = '', flags = '', mode = 0):
+		"""Execute a file.
+app is the name of a method in Applications, without the "app_"
+flags is a string consisting of applications.ALLOWED_FLAGS
+mode is a positive integer.
+Both flags and mode specify how the program is run."""
+
 		if type(files) not in (list, tuple):
 			files = [files]
 
@@ -73,35 +93,43 @@ class Actions(EnvironmentAware, SettingsAware):
 				apps = self.apps)
 	
 	def edit_file(self):
+		"""Calls execute_file with the current file and app='editor'"""
 		if self.env.cf is None:
 			return
 		self.execute_file(self.env.cf, app = 'editor')
 
 	def open_console(self, mode = ':'):
+		"""Open the console if the current UI supports that"""
 		if hasattr(self.ui, 'open_console'):
 			self.ui.open_console(mode)
 
 	def move_pointer(self, relative = 0, absolute = None):
+		"""Move the pointer down by <relative> or to <absolute>"""
 		self.env.cf = self.env.pwd.move_pointer(relative, absolute)
 
 	def move_pointer_by_pages(self, relative):
+		"""Move the pointer down by <relative> pages"""
 		self.env.cf = self.env.pwd.move_pointer(
 				relative = int(relative * self.env.termsize[0]))
 
 	def scroll(self, relative):
+		"""Scroll down by <relative> lines"""
 		if hasattr(self.ui, 'scroll'):
 			self.ui.scroll(relative)
 			self.env.cf = self.env.pwd.pointed_file
 
 	def redraw(self):
+		"""Redraw the window"""
 		self.ui.redraw()
 
 	def reset(self):
+		"""Reset the filemanager, clearing the directory buffer"""
 		old_path = self.env.pwd.path
 		self.env.directories = {}
 		self.enter_dir(old_path)
 
 	def toggle_boolean_option(self, string):
+		"""Toggle a boolean option named <string>"""
 		if isinstance(self.env.settings[string], bool):
 			self.env.settings[string] ^= True
 
-- 
cgit 1.4.1-2-gfad0