changeset 124:46b7d34ef0b2

Enhanced the module documentation of "kwarchive"
author Franz Glasner <hg@dom66.de>
date Fri, 17 Aug 2018 08:59:04 +0200
parents 86d5b69db499
children fb7e1e4e4d2c
files extensions/kwarchive.py
diffstat 1 files changed, 15 insertions(+), 5 deletions(-) [+]
line wrap: on
line diff
--- a/extensions/kwarchive.py	Fri Aug 17 08:58:41 2018 +0200
+++ b/extensions/kwarchive.py	Fri Aug 17 08:59:04 2018 +0200
@@ -23,13 +23,14 @@
    #
    [patterns]
     #
-    # expand keywords in every python file except those matching "x*"
-    # using RCS style expansion format (which is the default style)
+    # Expand keywords in every python file except those matching "x*"
+    # using the default RCS style expansion format
+    #
     **.py =
     x*    = NO
-    # this file has reStructuredText style keyword expansion "|VCS<kw>|" only
+    # This file has reStructuredText style keyword expansion "|VCS<kw>|" only
     path:VERSION = reST
-    # this file has reStructuredText style and RCS style keyword expansion
+    # This file has reStructuredText style and RCS style keyword expansion
     path:README = reST, RCS
 
     #
@@ -37,10 +38,19 @@
     # A missing and/or empty section means that all predefined keywords
     # are expanded.
     #
+    # Consisting of key-value pairs with of the form
+    #
+    #     Alias = PreDefinedKeyword
+    #
+    # An empty `PreDefinedKeyword' means the identity.
+    #
     [keywords]
     # `Revision' and possibly the `VCSRevision' keyword is expanded
     Revision =
-    # `MyKeyword' is expanded with the contents of the pre-defined `JustDate'
+    #
+    # Additionally: `MyKeyword' is expanded with the contents of the
+    # pre-defined `JustDate'
+    #
     MyKeyword = JustDate
 
 A non-existing ``.hgkwarchive`` file deactivates keyword expansion as does