search

r-lib / pkgdown

Generate static html documentation for an R package
https://pkgdown.r-lib.org/
Other
721 stars 336 forks source link

Incomplete sentence in error message #2800

Closed Bisaloo closed 4 weeks ago

Bisaloo commented 1 month ago

when topics are missing from reference index.

A reprex is provided in pkgdown tests.

Code:

https://github.com/r-lib/pkgdown/blob/8d9cba19fe597bba170f8d4c99f351491ab4f4d1/tests/testthat/test-build-reference-index.R#L53-L61

Output:

https://github.com/r-lib/pkgdown/blob/8d9cba19fe597bba170f8d4c99f351491ab4f4d1/tests/testthat/_snaps/build-reference-index.md?plain=1#L53-L61

Relevant code chunk to modify:

https://github.com/r-lib/pkgdown/blob/8d9cba19fe597bba170f8d4c99f351491ab4f4d1/R/build-reference-index.R#L172-L179

jayhesselberth commented 1 month ago

It's not clear to me from the blame what was intended to follow "or".

Bisaloo commented 1 month ago

I suspect it was "or add them to link to the config file". I'm not completely sure either though.

hadley commented 4 weeks ago

Or add to the reference index, I assume.