Skip to content
New issue

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

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

Already on GitHub? Sign in to your account

Make API more ergonomic and document them #26

Merged
merged 1 commit into from
Apr 17, 2020
Merged

Make API more ergonomic and document them #26

merged 1 commit into from
Apr 17, 2020

Conversation

msk
Copy link
Member

@msk msk commented Apr 17, 2020

  • query_one has been renamed query_nearest.
  • query functions return indices and distances separately, so that
    data of the same kind are stored in a contiguous memory.

- `query_one` has been renamed `query_nearest`.
- `query` functions return indices and distances separately, so that
  data of the same kind are stored in a contiguous memory.
@codecov
Copy link

codecov bot commented Apr 17, 2020

Codecov Report

Merging #26 into master will not change coverage.
The diff coverage is n/a.

Impacted file tree graph

@@            Coverage Diff            @@
##            master       #26   +/-   ##
=========================================
  Coverage   100.00%   100.00%           
=========================================
  Files            2         2           
  Lines           12        12           
=========================================
  Hits            12        12           
Impacted Files Coverage Δ
src/distance.rs 100.00% <ø> (ø)
src/lib.rs 100.00% <ø> (ø)

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 6c5459b...aed8516. Read the comment docs.

@minshao minshao merged commit 8662ef7 into master Apr 17, 2020
@minshao minshao deleted the api-doc branch April 17, 2020 21:56
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants