microsoft / microsoft/SPTAG

spelling errors

Open
#244 4 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
C++
Stars
5k
Forks
622
Avg merge
8h 37m
Merged PRs (30d)
5

Description

There are a lot of spelling errors in the package.

These ones were found by codespell:

./README.md:91: tunning ==> tuning, running
./Wrappers/inc/CsharpCommon.i:104: copyed ==> copied
./Wrappers/inc/CsharpCommon.i:108: copyed ==> copied
./Wrappers/inc/CsharpCommon.i:109: copyed ==> copied
./AnnService/src/SSDServing/SelectHead_BKT/BootSelectHead.cpp:147: Seleted ==> Selected, deleted
./AnnService/inc/Socket/Packet.h:71: expeced ==> expected
./AnnService/inc/SSDServing/VectorSearch/SearchSsdIndex.h:618: Acess ==> Access
./AnnService/inc/SSDServing/VectorSearch/ExtraFullGraphSearcher.h:113: acutal ==> actual
./AnnService/inc/SSDServing/VectorSearch/BuildSsdIndex.h:675: Failt ==> Fail, failed
./AnnService/inc/Core/Common/NeighborhoodGraph.h:168: indexs ==> indexes, indices
./AnnService/inc/Core/Common/NeighborhoodGraph.h:173: indexs ==> indexes, indices
./AnnService/inc/Core/Common/NeighborhoodGraph.h:177: indexs ==> indexes, indices
./AnnService/inc/Core/Common/NeighborhoodGraph.h:200: indexs ==> indexes, indices
./AnnService/inc/Core/Common/NeighborhoodGraph.h:230: indexs ==> indexes, indices
./AnnService/inc/Core/Common/NeighborhoodGraph.h:251: indexs ==> indexes, indices
./AnnService/inc/Core/Common/cuda/ThreadHeap.hxx:69: entires ==> entries
./AnnService/inc/Core/Common/cuda/KNN.hxx:243: DEPRICATED ==> DEPRECATED
./docs/WindowsInstallation.md:21: lastest ==> latest
./docs/Parameters.md:23: childs ==> children, child's
./docs/Parameters.md:151: tunning ==> tuning, running
./docs/Parameters.md:156: tunning ==> tuning, running

These ones were found by spellintian:

./Dockerfile: python -> Python
./AnnService/inc/SSDServing/VectorSearch/SearchSsdIndex.h: Acess -> Access
./AnnService/inc/Core/Common/cuda/KNN.hxx: DEPRICATED -> DEPRECATED
./AnnService/inc/Core/Common/cuda/TPtree.hxx: dont -> don't
./docs/Parameters.md: childs -> children
./docs/Parameters.md: python -> Python
./docs/Tutorial.ipynb: python -> Python
./docs/LinuxInstallation.md: python -> Python

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Review the files and exact spelling replacements listed in the issue, beginning with the README, docs, and source headers identified by codespell and spellintian. Correct only the reported misspellings and capitalization, then rerun both spelling checks; done means the listed findings no longer appear.

Written by the indexing model from the issue text.

Assessment

Tech stack
cpp
Domain
documentation
Issue type
Documentation
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Clearly specified
Newbie friendliness
55/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.