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

have a valid hyperlink in all error messages #2415

Closed
wants to merge 5 commits into from
Closed

have a valid hyperlink in all error messages #2415

wants to merge 5 commits into from

Conversation

olivroy
Copy link
Collaborator

@olivroy olivroy commented Mar 12, 2024

follow-up to #2403

You can see that some hyperlinks in errors will not work if your pkgdown config is pkgdown/_pkgdown.yml.

to test this interactively

usethis::edit_pkgdown_config()

# Add invalid options to articles or reference index.

I also decided to remove the pkgdown_config_href() function I introduced to use the same approach everywhere.

To avoid problems in tests when testing low level functions (when pkg doesn't exist), I added a fallback to pkgdown_config_relpath()

The solution is a bit ugly. But I couldn't see a better way to track pkg otherwise.

Maybe a better way would be to add a bullet that suggests {.run usethis::edit_pkgdown_config()} to solve this?

to avoid this
image

@hadley
Copy link
Member

hadley commented Mar 15, 2024

Yeah, I agree that recommending folks call usethis::edit_pkgdown_config() is the best option.

@olivroy
Copy link
Collaborator Author

olivroy commented Mar 15, 2024

Opened #2419 instead!

@olivroy olivroy closed this Mar 15, 2024
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.

2 participants