docs: fix typos and populate cspell dictionary#162
Merged
Conversation
Fix three genuine typos in roxygen documentation: - `ìters` -> `iters` (FSelectorBatchGeneticSearch) - `inversed` -> `inverse` (EnsembleFSResult) - `permutated` -> `permuted` (FSelectorBatchShadowVariableSearch) Populate the shared cspell dictionary with legitimate package names, jargon, author surnames, and abbreviations so cspell passes cleanly. Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
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.
Summary
Ran cspell across the package, fixed genuine typos, and populated the shared project dictionary so cspell passes cleanly (133 files, 0 issues).
Typos fixed
R/FSelectorBatchGeneticSearch.Rìters(accentedì)itersR/EnsembleFSResult.RinversedinverseR/FSelectorBatchShadowVariableSearch.RpermutatedpermutedThe same fixes are reflected in the regenerated
.Rdfiles and the obsoletepermutatedentry was removed frominst/WORDLIST.Dictionary
Added legitimate words to
.cspell/project-words.txt: package/class/function names (bbotk,Classif,clbk,fselect,rpart, …), optimization and stats jargon (Codomain,borda,jaccard,efsr,nfeatures, …), author surnames from the bibliography (Bischl,Bengio,Bergstra,López,Zobolas, …), and established abbreviations (evals,lrns,msrs,tsks, …).Notes
permutatedwas a judgment call — both forms exist, butpermutedis the standard term in ML writing, so I fixed rather than added it..Rdedits were applied surgically to avoid the unrelated reformatting churn that a fulldevtools::document()produces under the locally installed roxygen2 dev version.🤖 Generated with Claude Code