Georg Brandl avatar Georg Brandl committed f22705f

Adapt docstring to mercurial conventions.

Comments (0)

Files changed (1)

 # -*- coding: utf-8 -*-
+#
+# changelog mercurial extension
+#
+# Copyright (c) 2008-2010 by Georg Brandl, Armin Ronacher.
+#
+# This program is free software; you can redistribute it and/or modify it under
+# the terms of the GNU General Public License as published by the Free Software
+# Foundation; either version 2 of the License, or (at your option) any later
+# version.
+#
+# This program is distributed in the hope that it will be useful, but WITHOUT
+# ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
+# FOR A PARTICULAR PURPOSE.  See the GNU General Public License for more
+# details.
+#
+# You should have received a copy of the GNU General Public License along with
+# this program; if not, write to the Free Software Foundation, Inc., 51 Franklin
+# Street, Fifth Floor, Boston, MA 02110-1301 USA.
+#
+"""read commit message from changelog
+
+Usage: activate the extension and set the name of your changelog in hgrc::
+
+    [extensions]
+    hgchangelog = path/to/hgchangelog.py
+
+    [changelog]
+    filename = CHANGES
+
+Then, committing without a given message or logfile will check if the changelog
+is included in the commit.  If it is, the commit message shown in the editor
+will default to all text added to the changelog.
+
+Note: The ``changelog.filename`` setting is also useful to set in the
+per-repository configuration at ``.hg/hgrc``.
 """
-    hgchangelog
-    ~~~~~~~~~~~
 
-    Mercurial extension to read commit message from changelog.
+import re
 
-    Usage: activate the extension and set the name of your changelog in hgrc::
-
-        [extensions]
-        hgchangelog = path/to/hgchangelog.py
-
-        [changelog]
-        filename = CHANGES
-
-    Then, committing without a given message or logfile will check if the
-    changelog is included in the commit. If it is, the commit message shown
-    in the editor will default to all text added to the changelog.
-
-    :copyright: 2008, 2009 by Georg Brandl, Armin Ronacher.
-    :license:
-        This program is free software; you can redistribute it and/or modify it
-        under the terms of the GNU General Public License as published by the
-        Free Software Foundation; either version 2 of the License, or (at your
-        option) any later version.
-
-        This program is distributed in the hope that it will be useful, but
-        WITHOUT ANY WARRANTY; without even the implied warranty of
-        MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General
-        Public License for more details.
-
-        You should have received a copy of the GNU General Public License along
-        with this program; if not, write to the Free Software Foundation, Inc.,
-        51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
-"""
-import re
 from mercurial import commands, cmdutil, extensions, patch
 
 
Tip: Filter by directory path e.g. /media app.js to search for public/media/app.js.
Tip: Use camelCasing e.g. ProjME to search for ProjectModifiedEvent.java.
Tip: Filter by extension type e.g. /repo .js to search for all .js files in the /repo directory.
Tip: Separate your search with spaces e.g. /ssh pom.xml to search for src/ssh/pom.xml.
Tip: Use ↑ and ↓ arrow keys to navigate and return to view the file.
Tip: You can also navigate files with Ctrl+j (next) and Ctrl+k (previous) and view the file with Ctrl+o.
Tip: You can also navigate files with Alt+j (next) and Alt+k (previous) and view the file with Alt+o.