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

Create documentation issues for TDD #3267

Closed
hadley opened this issue Apr 24, 2019 · 3 comments
Closed

Create documentation issues for TDD #3267

hadley opened this issue Apr 24, 2019 · 3 comments

Comments

@hadley
Copy link
Member

hadley commented Apr 24, 2019

The top 20 most popular pages in the last month:

# A tibble: 20 x 5
   site    topic                  hits sessions users
   <chr>   <chr>                 <dbl>    <dbl> <dbl>
 1 ggplot2 geom_bar              29667    20885 21056
 2 ggplot2 labs                  26529    18670 21667
 3 ggplot2 geom_point            24415    16246 18717
 4 ggplot2 geom_text             21593    13430 15299
 5 ggplot2 lims                  18106    13172 15566
 6 ggplot2 theme                 16825     9323 11703
 7 ggplot2 geom_smooth           16301    11855 11662
 8 ggplot2 facet_grid            14653    10683 11147
 9 ggplot2 scale_gradient        13088     7602  8862
10 ggplot2 geom_histogram        12504     8515  9471
11 ggplot2 scale_continuous      12043     7053  9417
12 ggplot2 scale_manual          11775     7057  8990
13 ggplot2 ggtheme               11459     7397  9242
14 ggplot2 geom_boxplot          11425     8150  8652
15 ggplot2 guide_legend          10854     6737  8393
16 ggplot2 ggsave                10561     8019  8372
17 ggplot2 annotate               9717     6027  7314
18 ggplot2 geom_abline            9373     6333  7649
19 ggplot2 aes_colour_fill_alpha  9005     5509  7701
20 ggplot2 scale_brewer           8182     4646  6061

Need to take a look at each file, noting major deficiencies (i.e. needs proofreading, needs more description, needs more arguments, needs more examples) in a new issue.

@paleolimbot
Copy link
Member

paleolimbot commented May 2, 2019

Working on this now...leaving the linkified table here. I included some existing documentation issues that weren't in the original list...seemed like a good time to collect them all. I can't add a documentation or tidy-dev-day label, but I can go through these and open issues with what I think the main improvements could be. @thomasp85 this is what you had in mind?

topic tdd_issue existing_doc_issues code
facet_grid #3290 #3181 R/facet-grid-.r
facet_wrap #3290 #3181 R/facet-wrap.r
scale_gradient #3299 #3198 R/scale-gradient.r, R/zxx.r
scale_continuous #3298 R/scale-continuous.r
scale_discrete #3301 R/scale-discrete-.r
scale_brewer #3300 R/scale-brewer.r, R/zxx.r
scale_manual R/scale-manual.r, R/zxx.r
lims #3292 R/limits.r
labs #3292 R/labels.r
aes_colour_fill_alpha #3293 R/aes-colour-fill-alpha.r
aes_group_order #3293 R/aes-group-order.r
aes_linetype_size_shape #3293 R/aes-linetype-size-shape.r
aes_position #3293 R/aes-position.r
theme_get #3294 #3019 R/theme-current.R
theme #3294 R/theme.r
ggtheme #3294 R/theme-defaults.r
ggsave #3295 R/save.r
geom_bar R/geom-bar.r, R/geom-col.r, R/stat-count.r
geom_boxplot R/geom-boxplot.r, R/stat-boxplot.r
geom_point R/geom-point.r
geom_text R/geom-label.R, R/geom-text.r
geom_smooth R/geom-smooth.r, R/stat-smooth.r
geom_histogram #3269 #3269, #2323 R/geom-freqpoly.r, R/geom-histogram.r
geom_abline R/geom-abline.r, R/geom-hline.r, R/geom-vline.r
stat_ellipse #2775 R/stat-ellipse.R
geom_contour #2472, #2926 R/geom-contour.r, R/stat-contour.r
annotation_logticks #2703 R/annotation-logticks.r
annotate R/annotation.r
guide_legend R/guide-legend.r

@paleolimbot
Copy link
Member

I think I've done all I can for this. I couldn't find anything wrong with the geometry documentation...it's really excellent. All I can think of is the general-purpose problem of documenting aesthetics (#3297). Obviously feel free to debate/add to these when you aren't busy trying to release ggplot2!

@lock
Copy link

lock bot commented Dec 14, 2019

This old issue has been automatically locked. If you believe you have found a related problem, please file a new issue (with reprex) and link to this issue. https://reprex.tidyverse.org/

@lock lock bot locked and limited conversation to collaborators Dec 14, 2019
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants