refit
refit copied to clipboard
feature: Add Xml documentation for public methods
Is your feature request related to a problem? Please describe.
I recently started using this library and I found the lack of Xml documentation to be disorienting (compared to other OSS libraries and most of the .NET libraries). For example, I had to check the source code to know exactly what exception ApiResponse<T>.EnsureSuccessStatusCodeAsync() is throwing.
Describe the solution you'd like
I would like to add Xml docs. to various public methods and classes in the library.
Describe alternatives you've considered
I guess the alternative would be to leave the code as-is.
Describe suggestions on how to achieve the feature
Add Xml documentation to public methods and classes.
Additional context
I already started working on a Pull request to add Xml documentation on my fork of the repo. I really like this library and I think these comments would be a good addition.
Best regards,
Documentation is always very welcome!
@clairernovotny glad to hear that ! :)
This issue has been automatically locked since there has not been any recent activity after it was closed. Please open a new issue for related bugs.