Skip to content

Commit aff6d72

Browse files
committed
Re-document
1 parent 2b9b4dd commit aff6d72

File tree

3 files changed

+8
-6
lines changed

3 files changed

+8
-6
lines changed

DESCRIPTION

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -71,5 +71,5 @@ Suggests:
7171
covr
7272
License: MIT + file LICENSE
7373
VignetteBuilder: knitr
74-
RoxygenNote: 7.2.1
74+
RoxygenNote: 7.2.3
7575
Roxygen: list(markdown = TRUE)

R/cobertura.R

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
#' Create a Cobertura XML file
22
#'
3-
#' This functionality requires the xml2 package be installed. Create a
3+
#' Create a
44
#' cobertura-compliant XML report following [this
55
#' DTD](https://github.com/cobertura/cobertura/blob/master/cobertura/src/site/htdocs/xml/coverage-04.dtd).
66
#' Because there are _two_ DTDs called `coverage-04.dtd` and some tools do not seem to
@@ -9,9 +9,10 @@
99
#' context. Where `covr` doesn't provide a coverage metric (branch coverage,
1010
#' complexity), a zero is reported.
1111
#'
12+
#' *Note*: This functionality requires the xml2 package be installed.
13+
#'
1214
#' @param cov the coverage object returned from [package_coverage()]
1315
#' @param filename the name of the Cobertura XML file
14-
#' @author Willem Ligtenberg
1516
#' @export
1617
to_cobertura <- function(cov, filename = "cobertura.xml"){
1718

man/to_cobertura.Rd

Lines changed: 4 additions & 3 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

0 commit comments

Comments
 (0)