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>
This commit is contained in:
		
				
					committed by
					
						
						Nicolas Sebrecht
					
				
			
			
				
	
			
			
			
						parent
						
							29e9b7ab39
						
					
				
				
					commit
					d08f6d15c2
				
			@@ -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
 | 
			
		||||
 
 | 
			
		||||
		Reference in New Issue
	
	Block a user