[Feature]: Add News.md to default exclude
Problem Description
Most R packages / projects include a NEWS.md file which is essentially just a changelog. Unfortunately, this poisons much of the context with out of date or irrelevant information for the vast majority of R-based documentation.
For example, let's compare querying contrast in the emmeans github package to the website documentation:
Github
https://context7.com/rvlenth/emmeans?topic=contrast
Simple Argument for contrast
Source: https://github.com/rvlenth/emmeans/blob/master/NEWS.md
Adds a
simpleargument to thecontrastfunction in R. This argument serves as the complement to thebyargument, offering an alternative way to specify contrasts.contrast(..., simple = "level")
Website
https://context7.com/websites/rvlenth_github_io_emmeans?topic=contrast
R: Perform Interaction Contrasts
Source: https://rvlenth.github.io/emmeans/articles/AQuickStart
Demonstrates how to perform interaction contrasts, which are contrasts of contrasts, using the emmeans package. This involves chaining calls to
pairs()orcontrast()onemmGridobjects. Theby = NULLargument is essential for the first method.CON <- pairs(EMM, by = "dose") contrast(CON, "consec", by = NULL) # by = NULL is essential here!contrast(EMM, interaction = c("pairwise", "consec"))
Proposed Solution
Add NEWS.md / News.md / news.md to the default excluded files.
Alternatives Considered
No response
Priority
Would improve my workflow
Additional Context
No response
i added NEWS.md to our excluded file list. new deploy eta 1 week
This is merged and should be deployed by now
Are we sure this has been deployed? Just updated and tested emmeans on the website with the same query and the top hit was context from NEWS.md
New
simpleArgument forcontrast(emmeans 1.1.2)Source: https://github.com/rvlenth/emmeans/blob/master/NEWS.md
Introduces a
simpleargument for thecontrastfunction. This argument acts as the complement to thebyargument, offering an alternative way to specify contrasts.contrast(..., simple = TRUE)