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

Confusing error message #1941

Closed
jennybc opened this issue Dec 2, 2021 · 0 comments · Fixed by #1995
Closed

Confusing error message #1941

jennybc opened this issue Dec 2, 2021 · 0 comments · Fixed by #1995
Labels
feature a feature request or enhancement reference 📚

Comments

@jennybc
Copy link
Member

jennybc commented Dec 2, 2021

I just inherited gmailr and found that its site hasn't been building for a while.

The problem was an empty item:

r-lib/gmailr@d5d90f3#diff-f5f791eb2285a738ec729c44088e49a60ddf355eb479fb1fb5df7fcea4fea2e8L75

but the pkgdown error message is a bit misleading. I figure the error with previous pkgdown isn't that interesting, but you can see it in GHA logs.

With current dev pkgdown, the error is

-- Building function reference -------------------------------------------------
Error : Item 1 in section 8 in reference in '_pkgdown.yml' must be a character.
ℹ You might need to add '' around e.g. - 'N' or - 'off'.
Error: callr subprocess failed: Item 1 in section 8 in reference in '_pkgdown.yml' must be a character.
ℹ You might need to add '' around e.g. - 'N' or - 'off'.

This bit was accurate: section 8 in reference in '_pkgdown.yml'.

But this was wrong: Item 1 in ... (or else maybe I misunderstand what Item 1 refers to).

And this hints feels very specific, but it's also sort of a misdiagnosis:

ℹ You might need to add '' around e.g. - 'N' or - 'off'.`
@hadley hadley added feature a feature request or enhancement reference 📚 labels Jan 6, 2022
hadley pushed a commit that referenced this issue Jan 6, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
feature a feature request or enhancement reference 📚
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants