Document the splunksql package

[MrAlias]

Resolve #103

[codecov-commenter]

Codecov Report

Merging #124 (78b580c) into main (96b06ee) will not change coverage.
The diff coverage is n/a.

@@           Coverage Diff           @@
##             main     #124   +/-   ##
=======================================
  Coverage   81.07%   81.07%           
=======================================
  Files          21       21           
  Lines         856      856           
=======================================
  Hits          694      694           
  Misses        130      130           
  Partials       32       32           

Flag	Coverage Δ
Linux	79.90% <ø> (ø)
Windows	80.37% <ø> (ø)
macOS	79.20% <ø> (?)

Flags with carried forward coverage won't be shown. Click here to find out more.

---

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 96b06ee...78b580c. Read the comment docs.

[pellared]

BTW WDYT about #88 (comment)?

[pellared]

Do you think it would be valuable to documented what spans, attributes, events are created using this package?

[MrAlias]

Do you think it would be valuable to documented what spans, attributes, events are created using this package?

This seems like something that would become stale easily. Having stale docs can cause more harm then good.

[MrAlias]

BTW WDYT about #88 (comment)?

I like the idea, but I'm not entirely sure how to include an attribute from the context without adding some additional functionality. I'd be interested in seeing an example if you have one, but I would also not want to block this PR on including that. What do you think @pellared?