Patchwork [01,of,18,"] verify: document the `warn` method

login
register
mail settings
Submitter Pierre-Yves David
Date March 6, 2019, 4:29 p.m.
Message ID <4df3541cd0704c1df647.1551889757@nodosa.octopoid.net>
Download mbox | patch
Permalink /patch/39095/
State Accepted
Headers show

Comments

Pierre-Yves David - March 6, 2019, 4:29 p.m.
# HG changeset patch
# User Pierre-Yves David <pierre-yves.david@octobus.net>
# Date 1551867785 -3600
#      Wed Mar 06 11:23:05 2019 +0100
# Node ID 4df3541cd0704c1df6476b04a2b83aa7ff247ad8
# Parent  82d9728ace9535057d77df6c920385861ec00072
# EXP-Topic verify
# Available At https://bitbucket.org/octobus/mercurial-devel/
#              hg pull https://bitbucket.org/octobus/mercurial-devel/ -r 4df3541cd070
verify: document the `warn` method

This is the first bit of an effort to document and augment the verify code.
Pulkit Goyal - March 6, 2019, 6:32 p.m.
On Wed, Mar 6, 2019 at 7:42 PM Pierre-Yves David <
pierre-yves.david@ens-lyon.org> wrote:

> # HG changeset patch
> # User Pierre-Yves David <pierre-yves.david@octobus.net>
> # Date 1551867785 -3600
> #      Wed Mar 06 11:23:05 2019 +0100
> # Node ID 4df3541cd0704c1df6476b04a2b83aa7ff247ad8
> # Parent  82d9728ace9535057d77df6c920385861ec00072
> # EXP-Topic verify
> # Available At https://bitbucket.org/octobus/mercurial-devel/
> #              hg pull https://bitbucket.org/octobus/mercurial-devel/ -r
> 4df3541cd070
> verify: document the `warn` method
>
> This is the first bit of an effort to document and augment the verify code.
>

Queued 1-17, many many thanks for adding documentation.

Patch

diff --git a/mercurial/verify.py b/mercurial/verify.py
--- a/mercurial/verify.py
+++ b/mercurial/verify.py
@@ -52,6 +52,7 @@  class verifier(object):
         self.warnorphanstorefiles = True
 
     def warn(self, msg):
+        """record a "warning" level issue"""
         self.ui.warn(msg + "\n")
         self.warnings += 1