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_missing_topics() returns an error when Sys.getenv("CI") == "true" #1395

Merged
merged 6 commits into from
Sep 21, 2020

Conversation

ThierryO
Copy link
Contributor

Closes #1378

Copy link
Member

@hadley hadley left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good. A few comments in line. Thanks for working on this!

R/build-reference-index.R Outdated Show resolved Hide resolved
R/build-reference-index.R Show resolved Hide resolved
R/build-reference.R Outdated Show resolved Hide resolved
tests/testthat/test-build-reference-index.R Outdated Show resolved Hide resolved
@ThierryO
Copy link
Contributor Author

@hadley can you have a look why the test coverage is failing? I can't find the unit test referenced in the error.

@hadley
Copy link
Member

hadley commented Sep 11, 2020

Looks good, thanks! You can ignore the test-coverage failure; I'm not sure what's going wrong but it's definitely not your fault.

I'll merge this after I finish the 1.6.1 release (which I had to push out quickly since I accidentally broke cross-site article linking 😞)

@hadley hadley merged commit e1e46f2 into r-lib:master Sep 21, 2020
@hadley
Copy link
Member

hadley commented Sep 21, 2020

FYI @wch

@kjhealy
Copy link

kjhealy commented Sep 22, 2020

Think I just got bitten by this when rebuilding a package website on GitHub. Isn't it often the case that you might not want e.g. internal, non-exported functions to be listed in the package website's index, even though they might be documented internally and appear in the package's R help pages and so on? This change seems to assume we always want every function in the package to appear on the website index. This doesn't seem right, though perhaps I'm just mistaken about what I think is standard practice.

@hadley
Copy link
Member

hadley commented Sep 22, 2020

@kjhealy I think the motivating principle is to keep the number of difference indices to a minimum; this change ensures that help(package = foo) lists the same functions as the pkgdown index.

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

Successfully merging this pull request may close these issues.

Suggestion: provide an option to turn the warnings of check_missing_topics() into errors.
3 participants