Rev 5202: Document what note does a little. in http://bazaar.launchpad.net/~lifeless/bzr/stuff

[Robert Collins]

At http://bazaar.launchpad.net/~lifeless/bzr/stuff

------------------------------------------------------------
revno: 5202
revision-id: robertc at robertcollins.net-20100504064659-d5ybq23qlzov7w90
parent: robertc at robertcollins.net-20100504062251-1ocjhrl53mum9ehw
committer: Robert Collins <robertc at robertcollins.net>
branch nick: stuff
timestamp: Tue 2010-05-04 18:46:59 +1200
message:
  Document what note does a little.
=== modified file 'bzrlib/trace.py'
--- a/bzrlib/trace.py	2010-03-30 14:44:30 +0000
+++ b/bzrlib/trace.py	2010-05-04 06:46:59 +0000
@@ -111,6 +111,11 @@
 
 
 def note(*args, **kwargs):
+    """Output a note to the user.
+
+    Takes the same parameters as logging.info.
+    :return: None
+    """
     # FIXME note always emits utf-8, regardless of the terminal encoding
     #
     # FIXME: clearing the ui and then going through the abstract logging