Skip to content

Check consistency of parameter names across packageΒ #202

@mpadge

Description

@mpadge

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 πŸ‘

Metadata

Metadata

Assignees

No one assigned

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions