tobias/docker-offlineimap
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

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

Browse Source 
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>
This commit is contained in:
Wieland Hoffmann 2015-01-11 18:15:16 +01:00 committed by Nicolas Sebrecht
parent 29e9b7ab39
commit d08f6d15c2
2 changed files with 7 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

3
docs/doc-src/conf.py
View File

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

5
offlineimap/folder/Base.py
View File

@ -441,6 +441,11 @@ class BaseFolder(object):
- headername: name of the header to add - headername: name of the header to add
- headervalue: value 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 This has to deal with strange corner cases where the header is
missing or empty. Here are illustrations for all the cases, missing or empty. Here are illustrations for all the cases,
showing where the header gets inserted and what the end result showing where the header gets inserted and what the end result