Add a @webapi_docs decorator to store docs on the function.

 






 

 


  Review Request #14046
  —
  Created July 17, 2024 and updated  — Latest diff uploaded 

 


















 

  

   Information

  





 
 

  david
 









 
 

  Djblets
 









 
 

  release-6.x
 









 
 

  
 









 
 

  
 






 




 

  

   Reviewers

  





 
 

  djblets
 









 
 

  
 






 








 





  


 
 

  
This change adds a new decorator for us to use for attaching

public-facing documentation to HTTP methods, rather than putting it into

the docstring. This will let us have internal codebase docs in the docstring

instead, which is much more appropriate.

 








  


 
 

  
Used along with a change to our webapidocs Sphinx extension to pull this

data out.

 







 









 





  








 




 







   

    
    
Diff Revision 2


This is not the most recent revision of the diff. The latest diff is revision 6. See what's changed.

    

 

 

 

 
orig
1
2
3
4
5
6

 



    


    

      
Commits

      

 

 

  
   First
   Last
  
  Summary
  ID
  Author
 



 
  
   
  
  
   
  
 
 
  
   
    

     Add a @webapi_docs decorator to store docs on the function.
     
This change adds a new decorator for us to use for attaching
public-facing documentation to HTTP methods, rather than putting it into
the docstring. This will let us have internal codebase docs in the docstring
instead, which is much more appropriate.

Testing Done:
Used along with a change to our webapidocs Sphinx extension to pull this
data out.

    

   
  		
  099af51e231f815a6a1a877c200ceef753422b24
  David Trowbridge
 




    


    
    

   

  

 









 

  

   
    

     
      
      djblets/webapi/decorators.py
     
    

   
  

 



 

  

   
    

     
      
      djblets/webapi/tests/test_decorators.py
     
    

   
  

 










     

    

   

  

  

   
   Loading...