Merge lp:~elopio/autopilot/fix1248751-two_dots into lp:autopilot

[Leo Arias]

On the log_action decorator, do not duplicate the ending period.

[Thomi Richards (thomir-deactivatedaccount)]

LGTM

review: Approve

[PS Jenkins bot (ps-jenkins)]

review: Approve (continuous-integration)

=== modified file 'autopilot/logging.py'
--- autopilot/logging.py	2013-09-17 14:04:05 +0000
+++ autopilot/logging.py	2013-11-06 22:56:57 +0000
@@ -36,6 +36,9 @@
                 docstring = docstring.split('\n')[0].strip()
             else:
                 docstring = f.__name__
+            # Strip the ending periods of the docstring, if present, so only
+            # one will remain after using the log line format.
+            docstring = docstring.rstrip('.')
             log_line = '%s: %s. Arguments %s. Keyword arguments: %s.'
             log_func(
                 log_line, class_name, docstring, pprint.pformat(args),

=== modified file 'autopilot/tests/unit/test_logging.py'
--- autopilot/tests/unit/test_logging.py	2013-09-16 17:44:20 +0000
+++ autopilot/tests/unit/test_logging.py	2013-11-06 22:56:57 +0000
@@ -125,7 +125,7 @@
             'arg1', 'arg2', arg3='arg3', arg4='arg4')
         self.assertLogLevelContains(
             'INFO',
-            "ObjectWithLogDecorator: Do something with docstring.. "
+            "ObjectWithLogDecorator: Do something with docstring. "
             "Arguments ('arg1', 'arg2'). "
             "Keyword arguments: {'arg3': 'arg3', 'arg4': 'arg4'}.")
 
@@ -135,6 +135,6 @@
         self.assertLogLevelContains(
             'INFO',
             "ObjectWithLogDecorator: "
-            "Do something with a multiline docstring.. "
+            "Do something with a multiline docstring. "
             "Arguments ('arg1', 'arg2'). "
             "Keyword arguments: {'arg3': 'arg3', 'arg4': 'arg4'}.")