context7 icon indicating copy to clipboard operation
context7 copied to clipboard

[Feature]: Add News.md to default exclude

Open nlubock opened this issue 2 months ago • 3 comments

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 simple argument to the contrast function in R. This argument serves as the complement to the by argument, 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() or contrast() on emmGrid objects. The by = NULL argument 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

nlubock avatar Oct 17 '25 17:10 nlubock

i added NEWS.md to our excluded file list. new deploy eta 1 week

enesakar avatar Oct 19 '25 01:10 enesakar

This is merged and should be deployed by now

enesgules avatar Oct 31 '25 13:10 enesgules

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 simple Argument for contrast (emmeans 1.1.2)

Source: https://github.com/rvlenth/emmeans/blob/master/NEWS.md

Introduces a simple argument for the contrast function. This argument acts as the complement to the by argument, offering an alternative way to specify contrasts.

contrast(..., simple = TRUE)

nlubock avatar Nov 03 '25 23:11 nlubock