From fc4d37062c46886d3bc1fb0b6c3626d779be4ecd Mon Sep 17 00:00:00 2001
From: Ben Reynwar <ben@reynwar.net>
Date: Tue, 14 Aug 2012 10:28:23 -0700
Subject: docs: Modified argument formating in python docstrings in grc.

---
 grc/gui/StateCache.py | 20 +++++++++++++++-----
 1 file changed, 15 insertions(+), 5 deletions(-)

(limited to 'grc/gui/StateCache.py')

diff --git a/grc/gui/StateCache.py b/grc/gui/StateCache.py
index 3f6b792240..50d85bf960 100644
--- a/grc/gui/StateCache.py
+++ b/grc/gui/StateCache.py
@@ -30,7 +30,9 @@ class StateCache(object):
 	def __init__(self, initial_state):
 		"""
 		StateCache constructor.
-		@param initial_state the intial state (nested data)
+		
+		Args:
+		    initial_state: the intial state (nested data)
 		"""
 		self.states = [None] * STATE_CACHE_SIZE #fill states
 		self.current_state_index = 0
@@ -43,7 +45,9 @@ class StateCache(object):
 		"""
 		Save a new state.
 		Place the new state at the next index and add one to the number of previous states.
-		@param state the new state
+		
+		Args:
+		    state: the new state
 		"""
 		self.current_state_index = (self.current_state_index + 1)%STATE_CACHE_SIZE
 		self.states[self.current_state_index] = state
@@ -55,7 +59,9 @@ class StateCache(object):
 	def get_current_state(self):
 		"""
 		Get the state at the current index.
-		@return the current state (nested data)
+		
+		Returns:
+		    the current state (nested data)
 		"""
 		self.update_actions()
 		return self.states[self.current_state_index]
@@ -63,7 +69,9 @@ class StateCache(object):
 	def get_prev_state(self):
 		"""
 		Get the previous state and decrement the current index.
-		@return the previous state or None
+		
+		Returns:
+		    the previous state or None
 		"""
 		if self.num_prev_states > 0:
 			self.current_state_index = (self.current_state_index + STATE_CACHE_SIZE -1)%STATE_CACHE_SIZE
@@ -75,7 +83,9 @@ class StateCache(object):
 	def get_next_state(self):
 		"""
 		Get the nest state and increment the current index.
-		@return the next state or None
+		
+		Returns:
+		    the next state or None
 		"""
 		if self.num_next_states > 0:
 			self.current_state_index = (self.current_state_index + 1)%STATE_CACHE_SIZE
-- 
cgit v1.2.3