Make use of data set by @webapi_docs.

 






 

 


  Review Request #14045
  —
  Created July 17, 2024 and updated 

 




















 

  

   Information

  





 
 

  david
 









 
 

  Review Board
 









 
 

  master
 









 
 

  
 









 
 

  
 






 




 

  

   Reviewers

  





 
 

  reviewboard
 









 
 

  
 






 








 





  


 
 

  
This change updates our docs builder to prefer documentation included by

the new @webapi_docs decorator instead of relying purely on docstrings.

 








  


 
 

  
Migrated some API documentation out of docstrings into @webapi_docs and

built the user manual. Checked that the API documentation was correct.

 







 









 





  

 


 
 

  



 

  
   


    Summary
    ID

   

  
  

   


    

     

      Make use of data set by @webapi_docs.
      
This change updates our docs builder to prefer documentation included by
the new @webapi_docs decorator instead of relying purely on docstrings.

Testing Done:
Migrated some API documentation out of docstrings into @webapi_docs and
built the user manual. Checked that the API documentation was correct.

     


    		
    fe18b256ff4e74f5052d28a61f9cd2d374a6918a

   



  
 




 













 






 
 
 

  

   

    

     
    

    
    
     
  • 
      
     
    • 
     
  • 
      
     
    • 
     
  • 
      
     
    • 
     
  • 
      
     
    • 
     
  • 
      
     
    • 
    

   

   

    
     

      Description
      From
      Last Updated
     

    
    



     

      
       
       
module level import not at top of file Column: 1 Error code: E402

      		
      
       reviewbotreviewbot
      
      
       
      
     




     

      
       
       
Maybe better to assert docs is None or isinstance(docs, str) to avoid the assumption and keep the type safety.

      		
      
       chipx86chipx86
      
      
       
      
     




     

      
       
       
'typing.Optional' imported but unused Column: 1 Error code: F401

      		
      
       reviewbotreviewbot
      
      
       
      
     




     

      
       
       
'typing.cast' imported but unused Column: 1 Error code: F401

      		
      
       reviewbotreviewbot
      
      
       
      
     




     

      
       
       
module level import not at top of file Column: 1 Error code: E402

      		
      
       reviewbotreviewbot
      
      
       
      
     




     

      
       
       
module level import not at top of file Column: 1 Error code: E402

      		
      
       reviewbotreviewbot
      
      
       
      
     


    

 There are no open issues


   

  

 







 






  

 



















 




 

  


   

   

    
 
Checks run (1 failed, 1 succeeded)


    
   


  

  

  





 

 flake8
 failed.
 





 

 JSHint
 passed.
 













 
flake8

 


 










  

 





 














 





 

  

   




maubin




   

   







  

 



 

  


   

   

    
 
maubin



    
   


  

  

  



    




  1. 
 
    
  
    
   
    Ship It!
    
  
    
 
    

 
    
  


    
 
    
 
      

  

 
    


    

 
    

    2. 















  2. 
 
    
  
    
   
    
  
    
 
    

 
    
  


    
 
    
 
      

  

 
    


    

 
    

    3. 




  

 
















 





 

  

   




chipx86




   

   







  

 



 

  


   

   

    
 
chipx86



    
   


  

  

  



    




  1. 
 
    
  
    
   
    
  
    
 
    

 
    
  


    
 
    
 
      

  

 
    


    

 
    

    2. 

















  2. 
 
    
  
  
    
  
 
    
  
    
   
    
    
     
    
      
       docs/manual/_ext/webapidocs.py
       


        (Diff revision 1)


       
      
     
    
        
    
     
     
    

     
     
    

     
     
    

     
     
    

        
   
    
  
    
 
    

   
    
    
    




    
 
    
  
  
  
  
   Show all issues
  
 
    

    



    
    Maybe better to assert docs is None or isinstance(docs, str) to avoid the assumption and keep the type safety.
    
  
    
 
    

 
    
  


    
 
    
 
      

  

 
    


    

 
    

    3. 




  3. 
 
    
  
    
   
    
  
    
 
    

 
    
  


    
 
    
 
      

  

 
    


    

 
    

    4. 




  

 
















 



 

  

   




david




   

   

  

 



 

  


   

   

    
 Review request changed

    
   


  

  

  















  

   

    Commits:
   

   

    





 

  
   


    

    Summary
    ID

   

  
  

   


    

    

     

      Make use of data set by @webapi_docs.
      
This change updates our docs builder to prefer documentation included by
the new @webapi_docs decorator instead of relying purely on docstrings.

Testing Done:
Migrated some API documentation out of docstrings into @webapi_docs and
built the user manual. Checked that the API documentation was correct.

     


    		
    0586ba353239e1c80843ec74ccd55bcc707923f6

   




   


    

    

     

      Make use of data set by @webapi_docs.
      
This change updates our docs builder to prefer documentation included by
the new @webapi_docs decorator instead of relying purely on docstrings.

Testing Done:
Migrated some API documentation out of docstrings into @webapi_docs and
built the user manual. Checked that the API documentation was correct.

     


    		
    33f79e2f066d0becbe4153ed12a6a38db162c61a

   



  
 







   

  





  

   

    Diff:
   

   

    
 Revision 2 (+74 -8)
Show changes
 
 
   docs/manual/_ext/webapidocs.py 
 

   

  











 

  
Checks run (1 failed, 1 succeeded)



  

 flake8
 failed.
 





  

 JSHint
 passed.
 





 







 
flake8

 


 















  

 
















 



 

  

   




david




   

   

  

 



 

  


   

   

    
 Review request changed

    
   


  

  

  















  

   

    Commits:
   

   

    





 

  
   


    

    Summary
    ID

   

  
  

   


    

    

     

      Make use of data set by @webapi_docs.
      
This change updates our docs builder to prefer documentation included by
the new @webapi_docs decorator instead of relying purely on docstrings.

Testing Done:
Migrated some API documentation out of docstrings into @webapi_docs and
built the user manual. Checked that the API documentation was correct.

     


    		
    33f79e2f066d0becbe4153ed12a6a38db162c61a

   




   


    

    

     

      Make use of data set by @webapi_docs.
      
This change updates our docs builder to prefer documentation included by
the new @webapi_docs decorator instead of relying purely on docstrings.

Testing Done:
Migrated some API documentation out of docstrings into @webapi_docs and
built the user manual. Checked that the API documentation was correct.

     


    		
    fe18b256ff4e74f5052d28a61f9cd2d374a6918a

   



  
 







   

  





  

   

    Diff:
   

   

    
 Revision 3 (+74 -8)
Show changes
 
 
   docs/manual/_ext/webapidocs.py 
 

   

  











 

  
Checks run (1 failed, 1 succeeded)



  

 flake8
 failed.
 





  

 JSHint
 passed.
 





 







 
flake8

 


 















  

 
















 





 

  

   




maubin




   

   







  

 



 

  


   

   

    
 
maubin



    
   


  

  

  



    




  1. 
 
    
  
    
   
    Ship It!
    
  
    
 
    

 
    
  


    
 
    
 
      

  

 
    


    

 
    

    2. 















  2. 
 
    
  
    
   
    
  
    
 
    

 
    
  


    
 
    
 
      

  

 
    


    

 
    

    3. 




  

 









     

    

   

  

  

   
   Loading...