Documentation is incorrect? `sz_string_append` does not exist

ashvardanian / StringZilla

Up to 10x faster strings for C, C++, Python, Rust, and Swift, leveraging NEON, AVX2, AVX-512, and SWAR to accelerate search, sort, edit distances, alignment scores, etc 🦖

https://ashvardanian.com/posts/stringzilla/

Apache License 2.0

2.15k stars 73 forks source link

Documentation is incorrect? `sz_string_append` does not exist #87

Closed Frityet closed 7 months ago

Frityet commented 8 months ago

In the readme, a function named sz_string_append is referenced, but looking through the source code, its not defined at all, and I cannot use it in any code

ashvardanian commented 8 months ago

You are right! It was superseded by the expand API, and the docs fell behind. Can you please open a PR to refresh those? Thanks!

Frityet commented 8 months ago

Will do, I am currently adding Lua bindings to this library, and that will be in a later PR aswell

ashvardanian commented 8 months ago

Might be a good idea to split into separate smaller PRs, what do you think @Frityet?

Frityet commented 8 months ago

Might be a good idea to split into separate smaller PRs, what do you think @Frityet?

yeah, that is better, I'm still tryna get a hand with the new API (i don't see any documentation, so i am just doing testing) so it will be a bit

ashvardanian commented 8 months ago

What do you mean by the lack of docs? I believe the header is quite extensively documented 🤷‍♂️

ashvardanian commented 7 months ago

:tada: This issue has been resolved in version 3.3.1 :tada:

The release is available on GitHub release

Your semantic-release bot :package::rocket: