[media-split] Add code documentation
Add a docstring to MediaSplitter class explaining what it does and how to use it. Signed-off-by: Lubomír Sedlář <lsedlar@redhat.com>
This commit is contained in:
		
							parent
							
								
									97f9cc9abc
								
							
						
					
					
						commit
						79035ea7e6
					
				| @ -53,6 +53,15 @@ def convert_file_size(size, block_size=2048): | ||||
| 
 | ||||
| 
 | ||||
| class MediaSplitter(object): | ||||
|     """ | ||||
|     MediaSplitter splits files so that they fit on a media of given size. | ||||
| 
 | ||||
|     Each file added to the spliter has a size in bytes that will be rounded to | ||||
|     the nearest multiple of block size. If the file is sticky, it will be | ||||
|     included on each disk. The files will be on disks in the same order they | ||||
|     are added; there is no re-ordering. The number of disk is thus not the | ||||
|     possible minimum. | ||||
|     """ | ||||
|     def __init__(self, media_size, compose=None): | ||||
|         self.media_size = convert_media_size(media_size) | ||||
|         self.files = []  # to preserve order | ||||
|  | ||||
		Loading…
	
		Reference in New Issue
	
	Block a user