tidyverse / tidyverse/ggplot2

Expand the inline help text displayed for theme_sub_*() functions.

Open Beginner friendly
#6,873 3 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

documentation themes :dancer:
Dominant language
R
Stars
7k
Forks
2.1k
Avg merge
59m
Merged PRs (30d)
2

Description

The introduction of theme_sub_*() functions has made it much easier to structure and organize theme() customizations. However, when coding in RStudio, the inline help text shown for these functions is always the generic message:

"Arguments that are renamed and passed on to theme()."

As a result, users must manually consult the documentation for theme() to understand the meaning of the available arguments.

Since RStudio already displays inline help during code completion, it would be much more useful if the corresponding documentation from theme() were shown directly for each argument. This would reduce the need to switch between code and documentation and could significantly improve coding efficiency when working with ggplot2 themes.

Image

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by locating the documentation for the theme_sub_*() functions and the corresponding theme() argument descriptions. Update the inline help so each available argument shows the relevant theme() documentation, then verify the result through RStudio code completion or the project's documentation checks.

Written by the indexing model from the issue text.

Assessment

Tech stack
r
Domain
documentation
Issue type
Documentation
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Active
Clarity
Mostly clear
Newbie friendliness
70/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.