Skip to content

Move docs for locations helper into own topic #1658

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

Merged
merged 6 commits into from
May 12, 2024

Conversation

olivroy
Copy link
Collaborator

@olivroy olivroy commented May 12, 2024

Summary

This PR tweaks the docs for the cells_*() functions.

The idea is that there was duplication.

  • This adds cross-refs between the functions that use locations (tab_style(), tab_footnote() and the text transforming text_*() functions.

This removes the description of other cells_*() in each cells*() topic and moves this to a central location. ?location-helper

This adds a couple of cross-refs to the location-helper topic to make it easy to preview it easily from the help pane.

The reason behind is that you usually don't really want to move between cells_* functions, but rather tab_* <-> cells_*().

For fixing _pkgdown.yml, I use has_concept() (topic matching)

Let me know if you like the approach or if you have suggestions on how to further improve it! I tried separating the commits as much as possible!

I am also able to use @InheritParams for locations and .locations as roxygen2 understands this pattern.

Checklist

@rich-iannone
Copy link
Member

I really like this a lot! And it addresses something I was never really satisfied with (the really excessive repetition across so many docs). I’m thinking we go with this and make additional tweaks as necessary.

@rich-iannone
Copy link
Member

Let me know when your changes are finalized. At that point I’ll review and merge.

@olivroy
Copy link
Collaborator Author

olivroy commented May 12, 2024

Yes! this is ready for review! I was done with my proposed changes

@olivroy olivroy changed the title Reduce duplication of location helpers Reduce doc duplication of location helpers May 12, 2024
Copy link
Member

@rich-iannone rich-iannone left a comment

Choose a reason for hiding this comment

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

LGTM!

@rich-iannone rich-iannone merged commit 18b06ab into rstudio:master May 12, 2024
12 checks passed
@olivroy olivroy changed the title Reduce doc duplication of location helpers Move docs for locations helper into own topic May 12, 2024
@olivroy olivroy deleted the family branch May 12, 2024 15:26
@olivroy olivroy mentioned this pull request May 21, 2024
9 tasks
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