Tweaks in error chaining and path display #2403
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
hadley
approved these changes
Mar 11, 2024
|
Sure, what about this: * `check_pkgdown()` now provides a clickable hyperlink to your pkgdown config file (@olivroy, #2403). |
|
Hmmm, that seems so minor it's probably not worth a bullet. But folks will appreciate it 😄 |
SebKrantz
pushed a commit
to SebKrantz/pkgdown
that referenced
this pull request
Jun 1, 2024
* cli fixes * Fix chaining in `check_pkgdown()` + add hyperlink to `_pkgdown.yml` in error message. * Actually show snapshot by using `cli_inform()` instead of `cli_alert_success()`. * Remove unrelated changes
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
In current dev, the link created by
check_pkgdown()if success was invalid if usingcheck_pkgdown("C:/users/path/to/package/"). This PR fixes it as well as doing some touchups on the cli conversion.Tweaks to output of
check_pkgdown(). I used a new helper function to ensure thatcheck_pkgdown()works if you providepkg.Currently, it didn't work as expected. Also added some chaining, so that it would display Error in
check_pkgdown()instead of Error incheck_missing_topics().Also took advantage of cli inline markup for
{.pkg}FWIW, I am testing this with r-lib/devtools#2561 and it is working pretty well!