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

chore: adds crate-ci/typos to check repository's spelling #3022

Merged
merged 9 commits into from
Oct 22, 2024

Conversation

broccoliSpicy
Copy link
Contributor

@broccoliSpicy broccoliSpicy commented Oct 18, 2024

This PR tries to introduce the spelling check workflow from typos to ensure we have correct spelling in our repository.

to escape the typo checking, we can add the words and files that we want to escape to lance_repo/.typos.toml
like this:

[default.extend-words]
DNE = "DNE"
arange = "arange"
nd = "nd"
terrestial = "terrestial"
abd = "abd"
afe = "afe"

[files]
extend-exclude = ["notebooks/*.ipynb"]

@github-actions github-actions bot added the chore label Oct 18, 2024
@broccoliSpicy broccoliSpicy changed the title chore: adds crate-ci/typos@v1.26.0 to check repository's spelling chore: adds crate-ci/typos to check repository's spelling Oct 18, 2024
Copy link
Contributor

@westonpace westonpace left a comment

Choose a reason for hiding this comment

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

Some of these extend beyond just comment changes but I don't think I see any code changes that would impact the public API.

@westonpace
Copy link
Contributor

(also, need CI to pass before merging)

@broccoliSpicy
Copy link
Contributor Author

Some of these extend beyond just comment changes but I don't think I see any code changes that would impact the public API.

yeah, many code variable names and field names are also affected in this PR change

@codecov-commenter
Copy link

codecov-commenter commented Oct 18, 2024

Codecov Report

Attention: Patch coverage is 74.24242% with 17 lines in your changes missing coverage. Please review.

Project coverage is 78.38%. Comparing base (7413344) to head (8ab5a0d).

Files with missing lines Patch % Lines
rust/lance/src/index/vector/ivf.rs 25.00% 1 Missing and 2 partials ⚠️
java/core/lance-jni/src/blocking_dataset.rs 0.00% 2 Missing ⚠️
rust/lance-core/src/datatypes.rs 0.00% 2 Missing ⚠️
rust/lance-datagen/src/generator.rs 50.00% 2 Missing ⚠️
rust/lance-datafusion/src/exec.rs 0.00% 1 Missing ⚠️
.../lance-encoding/src/encodings/logical/primitive.rs 0.00% 1 Missing ⚠️
rust/lance-index/src/vector/pq.rs 0.00% 1 Missing ⚠️
rust/lance-index/src/vector/utils.rs 0.00% 1 Missing ⚠️
rust/lance-table/src/io/commit/dynamodb.rs 90.00% 1 Missing ⚠️
rust/lance/src/dataset/fragment.rs 80.00% 1 Missing ⚠️
... and 2 more
Additional details and impacted files
@@           Coverage Diff           @@
##             main    #3022   +/-   ##
=======================================
  Coverage   78.38%   78.38%           
=======================================
  Files         240      240           
  Lines       77121    77121           
  Branches    77121    77121           
=======================================
  Hits        60455    60455           
- Misses      13568    13574    +6     
+ Partials     3098     3092    -6     
Flag Coverage Δ
unittests 78.38% <74.24%> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.

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

@broccoliSpicy broccoliSpicy merged commit 27b919f into lancedb:main Oct 22, 2024
23 of 24 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants