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

Unify config error messages #2610

Merged
merged 6 commits into from
May 31, 2024
Merged

Unify config error messages #2610

merged 6 commits into from
May 31, 2024

Conversation

hadley
Copy link
Member

@hadley hadley commented May 30, 2024

To always show path at the beginning

@jayhesselberth @maelle what do you think of this style? I like it because it allows us to reuse more code when producing errors for Rmd metadata. If you like the basic idea, I'll spend a bit more time polishing the code before merging the PR. It'll also make it easier to integrate #2549, so that whenever the error occurs in a GHA, you'll get an annotation on the file that caused the problem.

To always show path at the beginning
@hadley hadley requested review from jayhesselberth and maelle May 30, 2024 22:19
Copy link

github-actions bot commented May 30, 2024

Copy link
Collaborator

@maelle maelle left a comment

Choose a reason for hiding this comment

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

yes, starting with the problematic thing looks like a good idea 👌

@@ -43,7 +43,7 @@ build_article <- function(name,

front <- rmarkdown::yaml_front_matter(input_path)
# Take opengraph from article's yaml front matter
front_opengraph <- check_open_graph(front$opengraph, input)
front_opengraph <- check_open_graph(pkg, front$opengraph, input)
Copy link
Collaborator

Choose a reason for hiding this comment

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

how many of pkgdown functions now need pkg as argument 😂

R/config.R Show resolved Hide resolved
@hadley hadley merged commit 44f90ab into main May 31, 2024
14 checks passed
@hadley hadley deleted the config-error-style branch May 31, 2024 13:29
SebKrantz pushed a commit to SebKrantz/pkgdown that referenced this pull request Jun 1, 2024
To always show path at the beginning, eliminating `config_path()` helper since it's no longer needed.
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.

3 participants