Mercurial > hg-stable

changeset 34348:01e8ab4b6573

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
releasenotes: update docstrings with information on additional flags This patch adds documentation related to the two new flags --check and --list for releasenotes extension. Differential Revision: https://phab.mercurial-scm.org/D544
author Rishabh Madan <rishabhmadan96@gmail.com>
date Tue, 29 Aug 2017 00:21:25 +0530
parents 741a511492d3
children b3538c03a804
files hgext/releasenotes.py
diffstat 1 files changed, 6 insertions(+), 0 deletions(-) [+]
line wrap: on
line diff
--- a/hgext/releasenotes.py	Thu Sep 28 13:22:58 2017 +0530
+++ b/hgext/releasenotes.py	Tue Aug 29 00:21:25 2017 +0530
@@ -550,6 +550,12 @@
     this command and changes should not be lost when running this command on
     that file. A particular use case for this is to tweak the wording of a
     release note after it has been added to the release notes file.
+
+    The -c/--check option checks the commit message for invalid admonitions.
+
+    The -l/--list option, presents the user with a list of existing available
+    admonitions along with their title. This also includes the custom
+    admonitions (if any).
     """
     sections = releasenotessections(ui, repo)