Choose where to document arguments (compare_values vs. headline)

[pwildenhain]

You use @inheritParams compare_values in the documentation, but then you also re-document parameters like round_all, multiplier, plural_phrases which are already documented in compare_values.

My recommendation is to remove the param descriptions from headline and just keep them in compare_values and let @inheritParams do the work of copying them over for you.

headliner/R/headline.R

Lines 7 to 18 in 1ce9ead

	#' @param plural_phrases named list of values to use when difference (delta) is
	#' singular (delta = 1) or plural (delta != 1)
	#' @param n_decimal numeric value to limit the number of decimal places in
	#' the returned values.
	#' @param round_all logical value to indicate if all values should be rounded.
	#' When FALSE, the values will return with no modification. When TRUE (default)
	#' all values will be round to the length specified by 'n_decimal'.
	#' @param multiplier number indicating the scaling factor. When multiplier = 1
	#' (default), 0.25 will return 0.25. When multiplier = 100, 0.25 will return 25.
	#' @param return_data logical to indicate whether function should return the
	#' phrase components used to compose the headline
	#' @inheritParams compare_values