Skip to content

Improve theme documentation #3294

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.

Sign up for GitHub

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

Jump to bottom
Closed
paleolimbot opened this issue May 2, 2019 · 1 comment · Fixed by #3782
Closed

Improve theme documentation #3294

paleolimbot opened this issue May 2, 2019 · 1 comment · Fixed by #3782
Labels
documentation tidy-dev-day 🤓 Tidyverse Developer Day

Comments

@paleolimbot
Copy link
Member

paleolimbot commented May 2, 2019 •
edited
Loading

There is an opportunity to improve the documentation related to themes, including the complete theme documentation, the theme() function documentation, and the default themes documentation. I seem to remember @clauswilke is in the process of improving themes in general, but I think these issues are general enough to tackle separately. This is a documentation issue intended for the tidyverse dev day (#3267).

  • The difference between theme_update() and theme_replace() is not clear from the documentation in theme_get (Updating a theme to remove panel.grid.major.x #3019). There are examples that make this distinction but not any text. This page should also link to theme(), which it currently does not.

  • theme() documentation should link to the complete themes (i.e., ggthemes) somewhere in the first paragraph (as the documentation for the complete themes does for theme()).
@paleolimbot paleolimbot mentioned this issue May 2, 2019
Closed
@clauswilke
Copy link
Member

Yes, I plan to work on the theme implementation, but that shouldn't prevent improvements to the current docs. Most of my work will be under the hood and won't affect the main usage patterns of themes.

@paleolimbot paleolimbot added documentation tidy-dev-day 🤓 Tidyverse Developer Day labels May 2, 2019
@Ryo-N7 Ryo-N7 mentioned this issue Jan 31, 2020
Merged
clauswilke pushed a commit that referenced this issue Feb 1, 2020
@Ryo-N7
update theme documentation reference links & clarify differences betw…
7e6d125 
…een theme_set and theme_update() (#3782)

* add complete themes reference link to theme docs, clarify difference between theme_set() and theme_update() with examples, references #3294

* fixes to comply with PR review. add theme_replace in bullet list summary, merge all update/set/replace examples into one section, references #3294

* theme_replace example made similar to theme_update example for better comparison, references #3294

* fix theme_update and theme_replace example to better show differences, references #3294
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
documentation tidy-dev-day 🤓 Tidyverse Developer Day
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

update theme documentation reference links & clarify differences between theme_set and theme_update()
2 participants
@clauswilke @paleolimbot