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

Make vector recycling rules its own FAQ #1885

Merged

Conversation

DavisVaughan
Copy link
Member

@DavisVaughan DavisVaughan commented Oct 10, 2023

Closes #1877

Tricky due to r-lib/pkgdown#1876

I was going to update our vector_recycling_rules page in vctrs to a true faq page with @name of theory-faq-recycling to match the other faq pages and use @aliases vector_recycling_rules to retain the old link. But since vector_recycling_rules won't get an html page since it is just an alias, that means the places in dplyr where we link to that page will be broken until dplyr rebuilds the site with the new version of vctrs, and I don't want that.

So instead I've kept vector_recycling_rules as the main @name.

To work around the pkgdown issue, I used a manual redirect in _pkgdown.yml to ensure vector_recycling_rules.html always exists

Screenshot 2023-10-10 at 3 54 23 PM

@olivroy
Copy link

olivroy commented Oct 10, 2023

Maybe the pkgdown redirects can help here? https://pkgdown.r-lib.org/news/index.html?q=redirects#new-features-2-0-0

R/faq-developer.R Show resolved Hide resolved
@DavisVaughan
Copy link
Member Author

@olivroy neat!

@DavisVaughan DavisVaughan merged commit e2291d0 into r-lib:main Oct 11, 2023
12 checks passed
@DavisVaughan DavisVaughan deleted the feature/vector-recycling-rules-faq branch October 11, 2023 13:53
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.

Should the recycling rules really be @internal?
3 participants