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

Check consistency of parameter names across package #202

Open
mpadge opened this issue Jul 5, 2024 · 0 comments
Open

Check consistency of parameter names across package #202

mpadge opened this issue Jul 5, 2024 · 0 comments

Comments

@mpadge
Copy link
Member

mpadge commented Jul 5, 2024

Idea from @PietrH via internal https://ropensci.slack.com/archives/C05C3GP1CSU/p1719994234029299, to check that

Function arguments that have similar (identical) descriptions have similar (identical) argument names across a package

Relatively easily done at scale these days thanks to developments like Finding near-duplicates with Jaccard similarity and MinHash, which could be applied to parameter descriptions. It would nevertheless involve a fair bit of work for a check that would likely almost never fail, so maybe not really worthwhile? This would also introduce some pretty heavy external deps in pkgcheck, along the likes of spacy or quanteda for efficient tokenization, which is also a minus. @PietrH happy to discuss further here. Thanks for the idea 👍

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

1 participant