comparison docs/changes.rst @ 215:ab3d0326419c

Doc: Move the "doc" to "docs"
author Franz Glasner <fzglas.hg@dom66.de>
date Wed, 08 May 2019 09:23:37 +0200
parents doc/changes.rst@344da17f01e3
children 42a6d59cf2ad
comparison
equal deleted inserted replaced
214:a35b0ca8b81f 215:ab3d0326419c
1 .. -*- coding: utf-8; mode: rst; -*-
2
3 =========
4 Changes
5 =========
6
7 All major changes over the versions are listed here. For breaking
8 changes have a look at :ref:`api-changes`, they are listed there in
9 detail.
10
11 .. include:: ../CHANGES.txt
12
13
14 .. _api-changes:
15
16 Breaking Changes
17 ================
18
19 0.7
20 ---
21
22 - A major overhaul of how filename extensions are associated with loaders
23 has been done:
24
25 + Filename extensions in :mod:`fnmatch` style are associated with
26 file-mode strings.
27
28 These file-mode strings are associated with loader
29 functions separately via the mapping :py:data:`configmix.mode_loaders`.
30
31 + :py:func:`configmix.set_assoc`, :py:func:`configmix.get_assoc`,
32 :py:func:`configmix.clear_assoc` and
33 :py:func:`configmix.get_default_assoc` are the new names for the old
34 `set_loader()`, `get_loader()`, `clear_loader()` and
35 `get_default_loader()` functions.
36 They are used for associating :mod:`fnmatch` style filename patterns
37 to file-mode strings. Previously they associated loader functions
38 directly.
39
40 + :py:func:`configmix.set_assoc` now requires a :mod:`fnmatch` style
41 pattern instead of just a file extension string (i.e. a plain trailer).
42 The previons dictionary with mapping from filename extensions to loader
43 callables is now a list of tuples containing the :mod:`fnmatch` style
44 pattern and the corresponding loader callable.
45
46
47 0.6
48 ---
49
50 - :py:func:`configmix.safe_merge` does now a deepcopy of all source
51 configurations when merging. Changes in configuration instances
52 afterwards will not be reflected in the merged configuration any
53 more.
54
55 The public signature of :py:func:`configmix.safe_merge` has *not*
56 changed.
57
58 - The default file encoding when reading INI style files with
59 :py:func:`configmix.ini.load` is now "UTF-8". Previously it was undefined
60 and therefore dependent on the user's locale.