📝 docs(DiscreteDataWorker.py): add docstring to run() method
This commit adds a docstring to the run() method in the DiscreteDataWorker class. The docstring explains what the method does, what it calculates, and what it emits. It also mentions that the result is saved in a file located in the output_path. This improves the readability and maintainability of the code.
This commit is contained in:
		
							parent
							
								
									a0e05be919
								
							
						
					
					
						commit
						4402085620
					
				@ -40,7 +40,15 @@ class DiscreteDataProcessWorker(Worker):
 | 
			
		||||
 | 
			
		||||
    def run(self):
 | 
			
		||||
        """
 | 
			
		||||
        Run the analyse
 | 
			
		||||
        This function is called when the thread is started.
 | 
			
		||||
        It calculates the discrete data and emits a dict with the following keys:
 | 
			
		||||
            - X moy (en mm)
 | 
			
		||||
            - Y moy (en mm)
 | 
			
		||||
            - Z moy (en mm)
 | 
			
		||||
            - Discretisation(en mm)
 | 
			
		||||
            - Rayon moyen (en mm)
 | 
			
		||||
            - Rayon ecart type (en mm)
 | 
			
		||||
        It also saves the result in a file that'll be located in the output_path
 | 
			
		||||
        """
 | 
			
		||||
        self.set_status("Calculating discrete data...")
 | 
			
		||||
        # Execute the analyse
 | 
			
		||||
 | 
			
		||||
		Loading…
	
		Reference in New Issue
	
	Block a user