# HG changeset patch # User Franz Glasner # Date 1534489144 -7200 # Node ID 46b7d34ef0b2996f4a24b3bf1002ba875a0c49b0 # Parent 86d5b69db4993df037db6fbc3b1a784e00504350 Enhanced the module documentation of "kwarchive" diff -r 86d5b69db499 -r 46b7d34ef0b2 extensions/kwarchive.py --- 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|" only + # This file has reStructuredText style keyword expansion "|VCS|" 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