fix: use godoc examples instead of code comments

InfluxCommunity / influxdb3-go

The go package that provides a simple and convenient way to interact with InfluxDB 3.

https://pkg.go.dev/github.com/InfluxCommunity/influxdb3-go

MIT License

21 stars 11 forks source link

fix: use godoc examples instead of code comments #78

Closed alespour closed 2 months ago

alespour commented 3 months ago

Proposed Changes

Examples (Write and New calls, Query is done in #76) are now in "godoc" style - compiled (but not executed during go test) code in example_XXX_test.go files, from which documentation examples are generated and linked with functions and types on pkg.go.dev portal, eg.:

Checklist

[x] Rebased/mergeable
[x] A test has been added if appropriate
[x] Tests pass
[x] Commit messages are conventional

codecov[bot] commented 3 months ago

Codecov Report

All modified and coverable lines are covered by tests :white_check_mark:

Project coverage is 83.38%. Comparing base (bd8ca70) to head (42d57df).

Additional details and impacted files

```diff @@ Coverage Diff @@ ## main #78 +/- ## ======================================= Coverage 83.38% 83.38% ======================================= Files 12 12 Lines 1011 1011 ======================================= Hits 843 843 Misses 138 138 Partials 30 30 ```

:umbrella: View full report in Codecov by Sentry.
:loudspeaker: Have feedback on the report? Share it here.

bednar commented 3 months ago

This is awesome! 👍