The Problem
Howdy! So, I've started to play around with SqlKata on a pretty large project with a lot of team members. The existing documentation has been very helpful to get started with the basics. However, I've found myself reading the code quite a bit to get an idea of how more complex scenarios work.
The Use-Case
While this makes a case for simply beefing up the existing github website, I believe it would be more helpful to include detailed XML documentation for public members and classes. Most developers I know tend to explore a new library via:
- An IDE, by exploring XML documentation comments in the IDE's intellisense tooltip box
- Exploring a complete reference website, which can be generated from a project with XML documentation (doxygen). This could even be hosted on the Github site.
- Lastly, exploring the code - which becomes clearer with XML documentation comments.
The Question
Would this be a worthwhile contribution? Some developers leave these out as a choice, as to not clutter the code itself. If this is something that would be considered helpful, I'd gladly volunteer (without any promises as to timeframe) to begin writing this documentation. Thoughts?
The Problem
Howdy! So, I've started to play around with SqlKata on a pretty large project with a lot of team members. The existing documentation has been very helpful to get started with the basics. However, I've found myself reading the code quite a bit to get an idea of how more complex scenarios work.
The Use-Case
While this makes a case for simply beefing up the existing github website, I believe it would be more helpful to include detailed XML documentation for public members and classes. Most developers I know tend to explore a new library via:
The Question
Would this be a worthwhile contribution? Some developers leave these out as a choice, as to not clutter the code itself. If this is something that would be considered helpful, I'd gladly volunteer (without any promises as to timeframe) to begin writing this documentation. Thoughts?