docs: Python floor is 3.8, not 3.7 - #120
Open
skritosss wants to merge 2 commits into
Open
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
What kind of change does this PR introduce?
Docs fix.
What is the current behavior?
The README badge, the README install section, and
docs/api.mdall say Python 3.7+.setup.pydisagrees:and the classifiers list 3.8 through 3.12. So someone on 3.7 follows the install instructions and gets
At least Python 3.8.0 is required.Looks like the floor was raised at some point and the docs were left behind.
What is the new behavior?
Three occurrences of 3.7 changed to 3.8. No code touched.
Additional context
While reading
docs/api.mdI also noticed a few smaller things: two typos (sucessfully,incldues), a sentence that repeats itself ("expect sub-minute a response in under a minute"), and the warning text quoted in the Query section sayscosine_similarity, which isn't a value ofIndexMeasure— the code emitsQuery does not have a covering index for {measure}. Kept them out of this PR to keep the diff on one topic; happy to send a follow-up if you want them fixed.Used Claude (Anthropic) to cross-check the docs against setup.py.