qdrant / go-client

Go client for Qdrant vector search engine
Apache License 2.0
161 stars 15 forks source link

Make examples compile and in godoc #60

Closed Brian-Williams closed 2 weeks ago

Brian-Williams commented 2 weeks ago

This will compile the tests so that it will fail if breaking changes are made. It will show these examples in godoc.

Screenshot 2024-10-20 at 3 07 30 PM Screenshot 2024-10-20 at 3 07 45 PM
Brian-Williams commented 2 weeks ago

Hey @Anush008. Libraries like NATS sometimes do have both godoc and examples folders. If we were only going to do one I would prefer godoc, but we can always do both.

It does get built, but differently than the client. Moving the file broke CI and it needed to be updated to pass gocritic. Also, I think we could add an output and actually run some of these. If we'd prefer to just keep examples as a link to source in godoc we can close.

Anush008 commented 2 weeks ago

These SDK methods are tested separately and since the examples directory is also checked during compilation, I think a reference to the examples directory in the API reference should suffice. What do you think?