XML Documentation on all public methods

[sqlkata]

XML Documentation on all public methods

[ahmad-moussawi]

Hi @natepisarski, the short answer is absolutely yes.
But keep in mind that the package is still in beta, while the majority of the API will stay the same, I can't guarantee that the public API will not change, especially that I am planning to add many useful features to it the soonest,

So I will appreciate in advance any effort regarding the docs 👍

[natepisarski]

@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 [Documented("12-08-2017")] and checking against a history of breaking changes automatically in the unit tests.

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 🥇

[ahmad-moussawi]

That really cool, please let me know if you I can help in this also

[IssueHuntBot]

@BoostIO funded this issue with $10. Visit this issue on Issuehunt

[IssueHuntBot]

@anonymousjaggu has started working. Visit this issue on Issuehunt