Join GitHub today
GitHub is home to over 50 million developers working together to host and review code, manage projects, and build software together.
Sign upXML Documentation on all public methods #35
Comments
|
Hi @natepisarski, the short answer is absolutely yes. So I will appreciate in advance any effort regarding the docs |
|
@ahmad-moussawi That's totally okay! Updates docs after a breaking change tends to be less of an investment than writing them in the first place. There's approaches I've seen (that are all overkill for the current state of the project) like leaving a Once I get a bit more well versed in the code I'll put up a documentation PR. I'd find it super helpful, and I bet plenty of people will as well. Thanks for being open to it |
|
That really cool, please let me know if you I can help in this also |
|
@BoostIO funded this issue with $10. Visit this issue on Issuehunt |
|
@anonymousjaggu has started working. Visit this issue on Issuehunt |
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?