Update docs to reference Python 3 and fix syntactical errors.

 






 

 


  Review Request #11284
  —
  Created Nov. 16, 2020 and submitted 

 




















 

  

   Information

  





 
 

  chipx86
 









 
 

  Review Board
 









 
 

  release-4.0.x
 









 
 

  
 









 
 

  
 






 




 

  

   Reviewers

  





 
 

  reviewboard
 









 
 

  
 






 








 





  


 
 

  
We now pull down the Python 3 intersphinx map, so that all Python

references will point to the Python 3 docs.


Doc syntax errors within the codebase have been fixed. These were

largely missing backticks, colons, or not escaping something like a

literal \n or \r.

 








  


 
 

  
Built the docs. Verified the references and that there were no build

errors.

 







 









 





  

 


 
 

  



 

  
   


    Summary
    ID

   

  
  

   


    

     

      Update docs to reference Python 3 and fix syntactical errors.
      
We now pull down the Python 3 intersphinx map, so that all Python
references will point to the Python 3 docs.

Doc syntax errors within the codebase have been fixed. These were
largely missing backticks, colons, or not escaping something like a
literal `\n` or `\r`.

     


    		
    f9f40847f363cc075148d793dcb37b833f6af425

   



  
 




 













 









 






  

 



















 




 




 














 





 

  

   




david




   

   





  

 



 

  


   

   

    
 
david


    
   


  

  

  



    




  1. 
 
    
  
    
   
    
  
    
 
    

 
    
  


    
 
    
 
      

  

 
    


    

 
    

    2. 







  2. 
 
    
  
  
    
  
   
    
    
    





    
    Does this mean that we should go through and change unicode references to str?
    
  
    
 
    

 
    
  


    
 
    
 
      

  


    1. 
 
 
      
 
      
  
 
      
 
      
  
      I don't think we should until we're fully on Python 3 for RB5. There's still an important distinction between the two.
      
 
      

      2. 



    2. 
 
 
      
 
      
  
 
      
 
      
  
      That is, str is still "native string", which will differ, and if someone's writing an extension or something, that'll be important.
      
 
      

      3. 


 
    


    

 
    

    3. 













  3. 
 
    
  
    
   
    
  
    
 
    

 
    
  


    
 
    
 
      

  

 
    


    

 
    

    4. 




  

 
















 





 

  

   




david




   

   







  

 



 

  


   

   

    
 
david


    
   


  

  

  



    




  1. 
 
    
  
    
   
    Ship It!
    
  
    
 
    

 
    
  


    
 
    
 
      

  

 
    


    

 
    

    2. 















  2. 
 
    
  
    
   
    
  
    
 
    

 
    
  


    
 
    
 
      

  

 
    


    

 
    

    3. 




  

 
















 



 

  

   




chipx86




   

   

  

 



 

  


   

   

    
 Review request changed

    
   


  

  

  







  

   

    Status:
   

   


    Completed

   

  




  

   

    Change Summary:
   

   

    
Pushed to release-4.0.x (f520388)