updated documentation for generate_diff_table.

1 files changed, 7 insertions, 0 deletions

diff --git a/src/gns-deb-diff.py b/src/gns-deb-diff.py
index e8fd2ae..c6362be 100644
--- a/src/gns-deb-diff.py
+++ b/src/gns-deb-diff.py
@@ -166,6 +166,13 @@ def slurp_readmes(package_list):
 def generate_diff_table(pkg_readmes):
     """Generates the gNewSense Debian Diff table in MoinMoin syntax and \
 returns it as a string.
+
+    The generated output is *not* clean since the content under the
+    Difference column often has newlines, which MoinMoin doesn't allow
+    inside a table.
+
+    So, you might have to manually clean the table before putting it
+    on the gNewSense Wiki.
     """
 
     table = [