Skip to content
New issue

Have a question about this project? # for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “#”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? # to your account

Fix minor typo (probably wrong reference) #95

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

MiWeiss
Copy link

@MiWeiss MiWeiss commented Oct 27, 2024

Pretty sure this change is what the author of the documentation intended (although, of course, the version currently on main is not wrong either) ;-)

Thanks heaps for open-sourcing voyager and for the very nice documentation.

@stephen29xie
Copy link
Contributor

Hi, thanks for reporting this. That appears to be a typo, it should be Index.add_item.

The way to update documentation is by generating the docs based on select source files. For this typo it is in bindings.cpp.

https://github.com/spotify/voyager/blob/main/CONTRIBUTING.md#updating-documentation has more info. I haven't been able to run that Python script consistently though. #92 is migrating the Python bindings from pybind11 to Nanobind, which should remove the need for that script once it is merged.

# for free to join this conversation on GitHub. Already have an account? # to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants