Add more detail to the write_config() docstring

Can be handy to know that the order of the assignments matches the
Kconfig files.

1 files changed, 10 insertions, 1 deletions

diff --git a/kconfiglib.py b/kconfiglib.py
index 99007a9..bd1e9eb 100644
--- a/kconfiglib.py
+++ b/kconfiglib.py
@@ -896,7 +896,16 @@ class Kconfig(object):
     def write_config(self, filename,
                      header="# Generated by Kconfiglib (https://github.com/ulfalizer/Kconfiglib)\n"):
         r"""
-        Writes out symbol values in the .config format.
+        Writes out symbol values in the .config format. The format matches the
+        C implementation, including ordering.
+
+        Symbols appear in the same order in generated .config files as they do
+        in the Kconfig files. For symbols defined in multiple locations, a
+        single assignment is written out corresponding to the first location
+        where the symbol is defined.
+
+        See the 'Intro to symbol values' section in the modules docstring to
+        understand which symbols get written out.
 
         filename:
           Self-explanatory.