canonise line params

Author: teunbrand

R/geom-bar.R

@@ -85,8 +85,6 @@ GeomBar <- ggproto(
 #' @param geom,stat Override the default connection between `geom_bar()` and
 #'   `stat_count()`. For more information about overriding these connections,
 #'   see how the [stat][layer_stats] and [geom][layer_geoms] arguments work.
-#' @param lineend Line end style (round, butt, square).
-#' @param linejoin Line join style (round, mitre, bevel).
 #' @examples
 #' # geom_bar is designed to make it easy to create bar charts that show
 #' # counts (or sums of weights)

R/geom-bin2d.R

@@ -22,8 +22,6 @@ GeomBin2d <- ggproto("GeomBin2d", GeomTile)
 #'   `geom_bin_2d()` and `stat_bin_2d()`. For more information about overriding
 #'   these connections, see how the [stat][layer_stats] and [geom][layer_geoms]
 #'   arguments work.
-#' @param lineend Line end style (round, butt, square).
-#' @param linejoin Line join style (round, mitre, bevel).
 #' @seealso [stat_bin_hex()] for hexagonal binning
 #' @examples
 #' d <- ggplot(diamonds, aes(x, y)) + xlim(4, 10) + ylim(4, 10)

R/geom-hex.R

@@ -81,9 +81,6 @@ GeomHex <- ggproto("GeomHex", Geom,
 #'   see how the [stat][layer_stats] and [geom][layer_geoms] arguments work.
 #' @export
 #' @inheritParams shared_layer_parameters
-#' @param lineend Line end style (round, butt, square).
-#' @param linejoin Line join style (round, mitre, bevel).
-#' @param linemitre Line mitre limit (number greater than 1).
 #' @export
 #' @examples
 #' d <- ggplot(diamonds, aes(carat, price))

R/geom-path.R

@@ -182,9 +182,6 @@ GeomStep <- ggproto(
 #'
 #' @aesthetics GeomPath
 #' @inheritParams shared_layer_parameters
-#' @param lineend Line end style (round, butt, square).
-#' @param linejoin Line join style (round, mitre, bevel).
-#' @param linemitre Line mitre limit (number greater than 1).
 #' @param arrow Arrow specification, as created by [grid::arrow()].
 #' @param arrow.fill fill colour to use for the arrow head (if closed). `NULL`
 #'        means use `colour` aesthetic.

R/geom-polygon.R

@@ -106,9 +106,6 @@ GeomPolygon <- ggproto("GeomPolygon", Geom,
 #'  [geom_ribbon()] for a polygon anchored on the x-axis
 #' @export
 #' @inheritParams shared_layer_parameters
-#' @param lineend Line end style (round, butt, square).
-#' @param linejoin Line join style (round, mitre, bevel).
-#' @param linemitre Line mitre limit (number greater than 1).
 #' @param rule Either `"evenodd"` or `"winding"`. If polygons with holes are
 #' being drawn (using the `subgroup` aesthetic) this argument defines how the
 #' hole coordinates are interpreted. See the examples in [grid::pathGrob()] for

R/geom-ribbon.R

@@ -249,7 +249,6 @@ GeomArea <- ggproto("GeomArea", GeomRibbon,
 #'   [geom_linerange()] for discrete intervals (lines),
 #'   [geom_polygon()] for general polygons
 #' @inheritParams shared_layer_parameters
-#' @param linemitre Line mitre limit (number greater than 1).
 #' @param outline.type Type of the outline of the area; `"both"` draws both the
 #'   upper and lower lines, `"upper"`/`"lower"` draws the respective lines only.
 #'   `"full"` draws a closed polygon around the area.

R/geom-rug.R

@@ -139,7 +139,6 @@ GeomRug <- ggproto("GeomRug", Geom,
 #'   bottom, and left.
 #' @param outside logical that controls whether to move the rug tassels outside of the plot area. Default is off (FALSE). You will also need to use `coord_cartesian(clip = "off")`. When set to TRUE, also consider changing the sides argument to "tr". See examples.
 #' @param length A [grid::unit()] object that sets the length of the rug lines. Use scale expansion to avoid overplotting of data.
-#' @param lineend Line end style (round, butt, square).
 #' @export
 #' @examples
 #' p <- ggplot(mtcars, aes(wt, mpg)) +

R/geom-segment.R

@@ -69,8 +69,6 @@ GeomSegment <- ggproto(
 #' @param arrow specification for arrow heads, as created by [grid::arrow()].
 #' @param arrow.fill fill colour to use for the arrow head (if closed). `NULL`
 #'        means use `colour` aesthetic.
-#' @param lineend Line end style (round, butt, square).
-#' @param linejoin Line join style (round, mitre, bevel).
 #' @seealso [geom_path()] and [geom_line()] for multi-
 #'   segment lines and paths.
 #' @seealso [geom_spoke()] for a segment parameterised by a location

R/layer.R

@@ -100,7 +100,16 @@
 #' * The `key_glyph` argument of [`layer()`] may also be passed on through
 #'   `...`. This can be one of the functions described as
 #'   [key glyphs][draw_key], to change the display of the layer in the legend.
-
+#'
+#' @param lineend
+#' Line end style, one of `"round"`, `"butt"` or `"square"`.
+#'
+#' @param linejoin
+#' Line join style, one of `"round"`, `"mitre"` or `"bevel"`.
+#'
+#' @param linemitre
+#' Line mitre limit, a number greater  than 1.
+#'
 #' @param orientation
 #' The orientation of the layer. The default (`NA`) automatically determines the
 #' orientation from the aesthetic mapping. In the rare event that this fails it