Skip to content

Conversation

@tylerhutcherson
Copy link
Collaborator

@tylerhutcherson tylerhutcherson commented Feb 1, 2024

This PR enhances the quality of the RedisVL README:

@tylerhutcherson tylerhutcherson added documentation Improvements or additions to documentation enhancement New feature or request labels Feb 1, 2024
@codecov-commenter
Copy link

codecov-commenter commented Feb 1, 2024

Codecov Report

Attention: 12 lines in your changes are missing coverage. Please review.

Comparison is base (8d38801) 80.62% compared to head (7500f30) 80.65%.

Files Patch % Lines
redisvl/index/index.py 47.61% 11 Missing ⚠️
redisvl/query/query.py 50.00% 1 Missing ⚠️
Additional details and impacted files
@@            Coverage Diff             @@
##             main     #105      +/-   ##
==========================================
+ Coverage   80.62%   80.65%   +0.02%     
==========================================
  Files          25       25              
  Lines        1476     1473       -3     
==========================================
- Hits         1190     1188       -2     
+ Misses        286      285       -1     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@tylerhutcherson tylerhutcherson force-pushed the readme-enhancement branch 2 times, most recently from 92e9134 to e22b2fe Compare February 1, 2024 15:13
@tylerhutcherson tylerhutcherson marked this pull request as ready for review February 1, 2024 15:14
bsbodden
bsbodden previously approved these changes Feb 1, 2024
Copy link
Collaborator

@bsbodden bsbodden left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM!

@tylerhutcherson tylerhutcherson changed the title Enhance README content Enhance README, docs, and examples Feb 8, 2024
@tylerhutcherson tylerhutcherson merged commit f430514 into main Feb 8, 2024
@tylerhutcherson tylerhutcherson deleted the readme-enhancement branch February 16, 2024 02:41
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation enhancement New feature or request

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Docstring error on schema distance_metrics -> distance_metric Add examples back to readme

5 participants