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

Add missing dep for vignette #85

Merged
merged 1 commit into from
Dec 23, 2021
Merged

Add missing dep for vignette #85

merged 1 commit into from
Dec 23, 2021

Conversation

@maelle maelle requested a review from marcosci December 13, 2021 15:28
@maelle
Copy link
Member Author

maelle commented Dec 13, 2021

You might also want to add

extra_packages:
to DESCRIPTION under Suggests actually 🤔

@maelle
Copy link
Member Author

maelle commented Dec 13, 2021

Now, if the deps are just for the website, you can use "Config/needs/website" instead of Suggests.

@marcosci
Copy link
Collaborator

Hi Maelle,

thanks for spotting this - but what exactly is Config/needs/website? 👯
I found it in pak, but ... can I somehow put this in the description?

Cheers

@maelle
Copy link
Member Author

maelle commented Dec 14, 2021

Sooo Config/needs/website is only for packages needed for the website but not R CMD check (e.g. packages used in a non-vignette article, packages needed for better autolinking by downlit e.g. if you mention an usethis function somewhere).

Now it's not supported just yet by the docs building system cf r-universe-org/build-docs#1 so my suggestion was a bit too early.

@maelle
Copy link
Member Author

maelle commented Dec 15, 2021

@marcosci I see this updated chapter https://r-pkgs.org/description.html of the R packages book has info on the Config/needs fields!

@jeroen
Copy link
Member

jeroen commented Dec 23, 2021

Let's give this a try to get the new docs online -- we can tweak it more later.

@jeroen jeroen merged commit 73500dc into master Dec 23, 2021
@mhesselbarth mhesselbarth deleted the maelle-patch-1 branch September 6, 2022 15:48
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