addmessageheader: Add a note about the incorrect rendering of the docstring

The note tells people to look at the source of the method, which
spinx.ext.viewcode conveniently links right next to the methods
signature.

Signed-off-by: Wieland Hoffmann <themineo@gmail.com>

docs/doc-src/conf.py

@@ -23,7 +23,8 @@ from offlineimap import __version__,__author__
 
 # Add any Sphinx extension module names here, as strings. They can be extensions
 # coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
-extensions = ['sphinx.ext.autodoc', 'sphinx.ext.doctest', 'sphinx.ext.intersphinx', 'sphinx.ext.todo']
+extensions = ['sphinx.ext.autodoc', 'sphinx.ext.doctest',
+              'sphinx.ext.intersphinx', 'sphinx.ext.todo', 'sphinx.ext.viewcode']
 autoclass_content = "both"
 
 # Add any paths that contain templates here, relative to this directory.

offlineimap/folder/Base.py

@@ -441,6 +441,11 @@ class BaseFolder(object):
         - headername: name of the header to add
         - headervalue: value of the header to add
 
+        .. note::
+
+           The following documentation will not get displayed correctly after being
+           processed by Sphinx. View the source of this method to read it.
+
         This has to deal with strange corner cases where the header is
         missing or empty.  Here are illustrations for all the cases,
         showing where the header gets inserted and what the end result