Fix up documentation and typing for patcher code.

 






 

 


  Review Request #14323
  —
  Created Feb. 3, 2025 and submitted  — Latest diff uploaded 

 


















 

  

   Information

  





 
 

  david
 









 
 

  RBTools
 









 
 

  master
 









 
 

  
 









 
 

  
 






 




 

  

   Reviewers

  





 
 

  rbtools
 









 
 

  
 






 








 





  


 
 

  
The patcher code had several docstrings with errors of various sorts.

This change fixes up:


    

  • Some parameter names were listed incorrectly or were missing.
    • 

  • Some method names were not in the imperative mood.
    • 

  • A few typos.
    • 



This also adds type definitions for the can_commit and

can_patch_empty_files attributes for the SCMClientPatcher.

 








  


 
 

  
Ran unit tests.

 







 









 





  








 




 







   

    
    
Diff Revision 1 (Latest)



    

    


    

      
Commits

      

 

 

  
   First
   Last
  
  Summary
  ID
  Author
 



 
  
   
  
  
   
  
 
 
  
   
    

     Fix up documentation and typing for patcher code.
     
The patcher code had several docstrings with errors of various sorts.
This change fixes up:

- Some parameter names were listed incorrectly or were missing.
- Some method names were not in the imperative mood.
- A few typos.

This also adds type definitions for the `can_commit` and
`can_patch_empty_files` attributes for the `SCMClientPatcher`.

Testing Done:
Ran unit tests.

    

   
  		
  f734fd232086870ad31a4e45b14d6669372d9d50
  David Trowbridge
 




    


    
    

   

  

 









 

  

   
    

     
      
      rbtools/clients/base/scmclient.py
     
    

   
  

 



 

  

   
    

     
      
      rbtools/diffs/patcher.py
     
    

   
  

 










     

    

   

  

  

   
   Loading...