mirror of
				https://github.com/python/cpython.git
				synced 2025-10-31 13:41:24 +00:00 
			
		
		
		
	Harmonize linesep docstrings, and fix the quoting of \r\n
This commit is contained in:
		
							parent
							
								
									f8b9dfd9a1
								
							
						
					
					
						commit
						cd37dfcfac
					
				
					 2 changed files with 6 additions and 3 deletions
				
			
		|  | @ -59,7 +59,7 @@ def write(self, s): | ||||||
|         self._fp.write(s) |         self._fp.write(s) | ||||||
| 
 | 
 | ||||||
|     def flatten(self, msg, unixfrom=False, linesep='\n'): |     def flatten(self, msg, unixfrom=False, linesep='\n'): | ||||||
|         """Print the message object tree rooted at msg to the output file |         r"""Print the message object tree rooted at msg to the output file | ||||||
|         specified when the Generator instance was created. |         specified when the Generator instance was created. | ||||||
| 
 | 
 | ||||||
|         unixfrom is a flag that forces the printing of a Unix From_ delimiter |         unixfrom is a flag that forces the printing of a Unix From_ delimiter | ||||||
|  | @ -70,7 +70,10 @@ def flatten(self, msg, unixfrom=False, linesep='\n'): | ||||||
|         Note that for subobjects, no From_ line is printed. |         Note that for subobjects, no From_ line is printed. | ||||||
| 
 | 
 | ||||||
|         linesep specifies the characters used to indicate a new line in |         linesep specifies the characters used to indicate a new line in | ||||||
|         the output. |         the output.  The default value is the most useful for typical | ||||||
|  |         Python applications, but it can be set to \r\n to produce RFC-compliant | ||||||
|  |         line separators when needed. | ||||||
|  | 
 | ||||||
|         """ |         """ | ||||||
|         # We use the _XXX constants for operating on data that comes directly |         # We use the _XXX constants for operating on data that comes directly | ||||||
|         # from the msg, and _encoded_XXX constants for operating on data that |         # from the msg, and _encoded_XXX constants for operating on data that | ||||||
|  |  | ||||||
|  | @ -276,7 +276,7 @@ def append(self, s, charset=None, errors='strict'): | ||||||
|         self._chunks.append((s, charset)) |         self._chunks.append((s, charset)) | ||||||
| 
 | 
 | ||||||
|     def encode(self, splitchars=';, \t', maxlinelen=None, linesep='\n'): |     def encode(self, splitchars=';, \t', maxlinelen=None, linesep='\n'): | ||||||
|         """Encode a message header into an RFC-compliant format. |         r"""Encode a message header into an RFC-compliant format. | ||||||
| 
 | 
 | ||||||
|         There are many issues involved in converting a given string for use in |         There are many issues involved in converting a given string for use in | ||||||
|         an email header.  Only certain character sets are readable in most |         an email header.  Only certain character sets are readable in most | ||||||
|  |  | ||||||
		Loading…
	
	Add table
		Add a link
		
	
		Reference in a new issue
	
	 R David Murray
						R David Murray