Updating most visited docs (#2553) #2727

dpseidel · 2018-06-29T17:08:19Z

A PR for various minor edits to documentation as I review and update the top 20 most visited webpages (#2553).

As this grows we may need to break it up into separate PRs. For now, I'm purposely holding off on committing updated .Rd files because edits like my removing a single unnecessary period in layer.r propagate into 20+ pages and will clutter the PR.

Remove duplicate graph from examples: extra layers now appear in legend by default and thus the example is unnecessary.

hadley

Looking good so far.

It would also be good to consider the page as a whole. For example, looking at https://ggplot2.tidyverse.org/reference/theme.html, is there some way we could make the initial paragraph more useful? Could we group some of the parameters together to reduce the cognitive load a bit? Can we link element_line in the parameter descriptions? Should we also link to vignette("ggplot2-specs")? (These bigger changes might be better as individual PRs)

hadley · 2018-06-29T17:55:56Z

R/geom-bar.r

@@ -4,7 +4,7 @@
 #' bar proportional to the number of cases in each group (or if the
 #' `weight` aesthetic is supplied, the sum of the weights). If you want the
 #' heights of the bars to represent values in the data, use
-#' \link{geom_col} instead. `geom_bar` uses `stat_count` by
+#' `geom_col` instead. `geom_bar` uses `stat_count` by


Can you put () after function calls?

hadley · 2018-06-29T17:57:35Z

R/geom-point.r

@@ -18,7 +18,7 @@
 #' There is no one solution to this problem, but there are some techniques


The section starting "The bubblechart" seems a bit weak.

I'm going to fill this PR just with minor edits and go back through for bigger changes to text in separate PRs. For instance here with "bubblechart", and with theme, etc.

dpseidel · 2018-07-09T17:33:48Z

@hadley This is ready to review & merge. Larger changes to documentation will be made in separate PRs.

batpigandme

Wooo! Impressive work – just a few minor (minour? minotaur?) changes here and there.

batpigandme · 2018-07-10T11:13:23Z

R/fortify-map.r

@@ -85,7 +85,7 @@ map_data <- function(map, region = ".", exact = FALSE, ...) {
 #' @param regions map region
 #' @param fill fill colour
 #' @param colour border colour
-#' @param xlim,ylim latitudinal and logitudinal range for extracting map
+#' @param xlim,ylim latitudinal and longitudinal range for extracting map


range ⇨ ranges (since there are now two of them to which we are referring)

batpigandme · 2018-07-10T11:15:24Z

R/geom-bar.r

@@ -1,12 +1,12 @@
 #' Bar charts
 #'
-#' There are two types of bar charts: `geom_bar` makes the height of the
+#' There are two types of bar charts: `geom_bar()` makes the height of the


Stylistic, but since we open with two types...: I would follow the colon with "geom_bar() and geom_col(). geom_bar() makes..."

batpigandme · 2018-07-10T11:17:37Z

R/geom-boxplot.r

@@ -49,7 +49,7 @@
 #'   if the notches of two boxes do not overlap, this suggests that the medians
 #'   are significantly different.
 #' @param notchwidth For a notched box plot, width of the notch relative to
-#'   the body (default 0.5)
+#'   the body (default = `0.5`)


~~Are we surrounding just the value of an argument with backticks? (I'm genuinely asking—if so, I think we're inconsistent)~~
Move backticks to surround argument and value.

So, for now I have left this as is because default is not an actually argument name. I could change this a couple ways:

"defaults to notchwidth = 0.5"

"default value is 0.5"

removal all together, they can look up to the function usage section?

preference? other options?

I like defaults to notchwidth = 0.5 — though, honestly, both make sense. Go with where the spirit moves you!

batpigandme · 2018-07-10T11:19:32Z

R/geom-smooth.r

@@ -7,7 +7,7 @@
 #'
 #' Calculation is performed by the (currently undocumented)
 #' `predictdf` generic and its methods.  For most methods the standard
-#' error bounds are computed using the [predict()] method - the
+#' error bounds are computed using the [predict()] method -- the
 #' exceptions are `loess` which uses a t-based approximation, and


commas between the geom and the descriptor (i.e. "loess, which..." and "glm, where...") I'm less wed to the one with glm, though.

batpigandme · 2018-07-10T11:25:11Z

R/geom-smooth.r

@@ -20,14 +20,14 @@
 #' @seealso See individual modelling functions for more details:
 #'   [lm()] for linear smooths,
 #'   [glm()] for generalised linear smooths,


If we're giving this one sentence structure (which we are, since there's a period after the last one) there should be an "and" added to the second to last list item. (Basically, "bulleted lists within sentences" structure: http://blog.apastyle.org/apastyle/2010/03/lists-part-5-bulleted-lists.html)

batpigandme · 2018-07-10T11:26:56Z

R/guide-colorbar.r

-#'   smoother colorbar for a larger value.
-#' @param raster A logical. If `TRUE` then the colorbar is rendered as a
-#'   raster object. If `FALSE` then the colorbar is rendered as a set of
+#' @param nbin A numeric specifying the number of bins for drawing colourbar. A


Add an article before "colourbar" (If you can have more than one, then "a," if not, then "the.")

batpigandme · 2018-07-10T11:29:49Z

R/guide-legend.r

@@ -4,8 +4,8 @@
 #' Legend guides for various scales are integrated if possible.
 #'
 #' Guides can be specified in each `scale_*` or in [guides()].
-#' `guide="legend"` in `scale_*` is syntactic sugar for
-#' `guide=guide_legend()` (e.g. `scale_color_manual(guide = "legend")`).
+#' `guide = "legend"` in `scale_*` is syntactic sugar for


re. my comment about backticks around arguments and their value, here there are backticks around both argument and value. I think we're wrapping both (see http://style.tidyverse.org/news.html#general-style), so I'd just move the backticks where mentioned earlier to encompass the argument name.

I agree in principle however "default" (from above) is not an actual argument name where guide is. Thoughts?

Oh, oh! I missed that. That makes sense. I almost think that it'd be better not to use =, in that case (e.g. is 0.5 by default, or default is 0.5 or whatever).

batpigandme · 2018-07-10T11:32:54Z

R/theme.r

@@ -161,16 +161,16 @@
 #'   (`element_text`; inherits from `title`) left-aligned by default
 #' @param plot.tag.position The position of the tag as a string ("topleft",
 #'   "top", "topright", "left", "right", "bottomleft", "bottom", "bottomright)
-#'   or a coordinate. If a string, extra space will be added to accomodate the
+#'   or a coordinate. If a string, extra space will be added to accommodate the


👏 I never spell the word accommodate correctly on the first try.

lock · 2019-01-09T19:54:15Z

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/

dpseidel added 10 commits June 29, 2018 09:55

Minor edits to README

5639ffa

Minor edits to reference home page

78de69d

Remove typo in layer.r

1b3c264

Minor edits to geom_bar documentation

e2a2170

Edits to geom_point documentation

5693127

Remove duplicate graph from examples: extra layers now appear in legend by default and thus the example is unnecessary.

Add period to vignette helper statement on docs

46b5836

Minor edits to geom-text docs

120fb05

Fix various typos in theme docs

af337d2

Minor edits to scale_continuous docs

3cef8ac

Minor edits to geom_smooth documentation

32a8673

hadley reviewed Jun 30, 2018

View reviewed changes

dpseidel added 4 commits July 2, 2018 12:07

Fix minor spelling errors throughout docs

736c368

Small edits on last most-visited

6f6f472

Rebuild documentation with small edits

0e072f2

Minor fix to scale-continuous

31b6554

hadley requested a review from batpigandme July 9, 2018 23:02

batpigandme suggested changes Jul 10, 2018

View reviewed changes

dpseidel added 2 commits July 10, 2018 15:22

Minor grammatical changes

ab756df

final edit

884e543

dpseidel force-pushed the docreview branch from 163aa7f to 884e543 Compare July 10, 2018 23:01

batpigandme approved these changes Jul 10, 2018

View reviewed changes

dpseidel merged commit 17b45f9 into tidyverse:master Jul 10, 2018

dpseidel deleted the docreview branch July 13, 2018 19:30

dpseidel mentioned this pull request Jul 31, 2018

Update theme documentation #2791

Merged

dpseidel mentioned this pull request Aug 13, 2018

Update theme.html tidyverse/ggplot2-docs#1

Closed

lock bot locked and limited conversation to collaborators Jan 9, 2019

		@@ -18,7 +18,7 @@
		#' There is no one solution to this problem, but there are some techniques

Updating most visited docs (#2553) #2727

Updating most visited docs (#2553) #2727

Uh oh!

Conversation

dpseidel commented Jun 29, 2018 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

hadley left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

dpseidel commented Jul 9, 2018

Uh oh!

batpigandme left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

lock bot commented Jan 9, 2019

Uh oh!

Uh oh!

dpseidel commented Jun 29, 2018 •

edited

Loading