Skip to content

Commit

Permalink
Document class mappings in changelog
Browse files Browse the repository at this point in the history
Signed-off-by: martin f. krafft <madduck@madduck.net>
  • Loading branch information
madduck committed Dec 10, 2013
1 parent 05cbf6b commit 010ea27
Show file tree
Hide file tree
Showing 2 changed files with 10 additions and 0 deletions.
2 changes: 2 additions & 0 deletions doc/source/changelog.rst
Expand Up @@ -5,6 +5,8 @@ ChangeLog
========= ========== ========================================================
Version Date Changes
========= ========== ========================================================
* Introduce class mappings (see :doc:`operations`)
(closes: #5)
* Fix parameter interpolation across merged lists
(closes: #13).
* Caching of classes for performance reasons, especially
Expand Down
8 changes: 8 additions & 0 deletions doc/source/operations.rst
Expand Up @@ -92,6 +92,14 @@ end with ``.ch`` (again, note the escaped leading asterisk). Multiple classes
can be assigned to each mapping by providing a space-separated list (class
names cannot contain spaces anyway).

.. warning::

The class mappings do not really belong in the configuration file, as they
are data, not configuration inmformation. Therefore, they are likely going
to move elsewhere, but I have not quite figured out to where. Most likely,
there will be an additional file, specified in the configuration file, which
then lists the mappings.

Note that mappings are not designed to replace node definitions. Mappings can
be used to pre-populate the classes of existing nodes, but you still need to
define all nodes (and if only to allow them to be enumerated for the
Expand Down

0 comments on commit 010ea27

Please sign in to comment.