freemyipod r444 - Code Review

Repository:	freemyipod
Revision:	< r443‎ \| r444 \| r445 >
Date:	18:12, 18 January 2011
Author:	farthen
Status:	new
Tags:
Comment:	emcore.py: implement "emcore.py help" command that displays a short form of the function list for quick reference
Modified paths:	/emcore/trunk/tools/emcore.py (modified) (history)

Diff [purge]

Index: emcore/trunk/tools/emcore.py
—	—	@@ -56,7 +56,7 @@
57	57	return "Expected " + str(self.expected) + ", but saw something else"
58	58
59	59
60		~~-def usage(errormsg=None, specific=False):~~
	60	+def usage(errormsg=None, specific=False, docstring=True):
61	61	"""
62	62	Prints the usage information.
63	63	It is auto generated from various places.
—	—	@@ -80,8 +80,8 @@
81	81	logger.log("[" + kwarg + " = " + str(kwvalue) + "] ")
82	82	if doc[function]['varargs']:
83	83	logger.log("<db1> ... <dbN>")
84		~~- logger.log("\n")~~
85		~~- if doc[function]['documentation']:~~
	84	+ if docstring and doc[function]['documentation']:
	85	+ logger.log("\n")
86	86	logger.log(doc[function]['documentation']+"\n", 4)
87	87	logger.log("\n")
88	88	logger.log("\n")
—	—	@@ -207,6 +207,11 @@
208	208	return "0x%x" % integer
209	209
210	210	@command
	211	+ def help(self):
	212	+ """ Generates a list of functions """
	213	+ usage(None, False, False)
	214	+
	215	+ @command
211	216	def getinfo(self, infotype):
212	217	"""
213	218	Get info on the running emCORE.