Patchwork ui: improve docs on ui.log

login
register
mail settings
Submitter Augie Fackler
Date Sept. 10, 2015, 2:50 p.m.
Message ID <18fd6b809fe39b25f752.1441896616@arthedain.pit.corp.google.com>
Download mbox | patch
Permalink /patch/10462/
State Accepted
Headers show

Comments

Augie Fackler - Sept. 10, 2015, 2:50 p.m.
# HG changeset patch
# User Augie Fackler <augie@google.com>
# Date 1441896603 14400
#      Thu Sep 10 10:50:03 2015 -0400
# Node ID 18fd6b809fe39b25f7525cf7019f58aaecd8dad5
# Parent  a4da463df6cf0d0bcf36afa478ed18d1c818ff3e
ui: improve docs on ui.log

This makes the documentation on ui.log line up with the use of that
interface in blackbox.
Matt Mackall - Sept. 13, 2015, 4:30 a.m.
On Thu, 2015-09-10 at 10:50 -0400, Augie Fackler wrote:
> # HG changeset patch
> # User Augie Fackler <augie@google.com>
> # Date 1441896603 14400
> #      Thu Sep 10 10:50:03 2015 -0400
> # Node ID 18fd6b809fe39b25f7525cf7019f58aaecd8dad5
> # Parent  a4da463df6cf0d0bcf36afa478ed18d1c818ff3e
> ui: improve docs on ui.log

Queued for default, thanks.

Patch

diff --git a/mercurial/ui.py b/mercurial/ui.py
--- a/mercurial/ui.py
+++ b/mercurial/ui.py
@@ -969,9 +969,12 @@  class ui(object):
 
         service should be a readily-identifiable subsystem, which will
         allow filtering.
-        message should be a newline-terminated string to log.
+
+        *msg should be a newline-terminated format string to log, and
+        then any values to %-format into that format string.
+
+        **opts currently has no defined meanings.
         '''
-        pass
 
     def label(self, msg, label):
         '''style msg based on supplied label