Closed canyon289 closed 2 years ago
I feel this library would benefit from API documentation, detailing
This library would also benefit from code documentation in the codebase itself. For esample here https://github.com/jeremiecoullon/SGMCMCJax/blob/master/sgmcmcjax/kernels.py#L13
Both suggestions could be solved in one shot by documenting the code in a standard documentation format and then using sphinx's automatic API documentation functionality.
Do note this library has excellent examples and applied documentation.
https://github.com/openjournals/joss-reviews/issues/4113
Done :)
I feel this library would benefit from API documentation, detailing
This library would also benefit from code documentation in the codebase itself. For esample here https://github.com/jeremiecoullon/SGMCMCJax/blob/master/sgmcmcjax/kernels.py#L13
Both suggestions could be solved in one shot by documenting the code in a standard documentation format and then using sphinx's automatic API documentation functionality.
Do note this library has excellent examples and applied documentation.
https://github.com/openjournals/joss-reviews/issues/4113