Skip to content

Commit 59dcecd

Browse files
committed
fix typos
1 parent dd09814 commit 59dcecd

File tree

6 files changed

+17
-11
lines changed

6 files changed

+17
-11
lines changed

R/bf_protocol.R

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -2,14 +2,14 @@
22
#'
33
#' @param name [`character(1)`][character]\cr simple name of this protocol.
44
#' @param description [`character(1)`][character]\cr formalised description of
5-
#' the operation in this protocol. It will be parsed with \code{\link{glue}}
6-
#' and used in the bitfield legend, so can include the test arguments as
7-
#' enbraced expressions.
5+
#' the operation in this protocol. It will be parsed with
6+
#' \code{\link[glue]{glue}} and used in the bitfield legend, so can include
7+
#' the test arguments as enbraced expressions.
88
#' @param test [`function(...)`][function]\cr the function used to build the bit
99
#' flag.
1010
#' @param example [`list(.)`][list]\cr named list that contains all arguments in
1111
#' \code{test} as name with values of the correct type.
12-
#' @param type [`character(1)`][character]\cr the encoding typ according to
12+
#' @param type [`character(1)`][character]\cr the encoding type according to
1313
#' which the bit flag is determined. Possible values are \code{bool} (for
1414
#' binary flags), \code{enum} (for cases), \code{int} (for integers) and
1515
#' \code{num} (for floating-point encoding).

R/bf_standards.R

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -27,8 +27,10 @@
2727
#' only be accessible to your personal R session.
2828
#' @return description
2929
#' @examples
30+
#' \dontrun{
3031
#' # list all currently available standards
3132
#' bf_standards()
33+
#' }
3234
#' @importFrom checkmate assertCharacter assertChoice assertList
3335
#' @importFrom methods functionBody
3436
#' @importFrom httr content

README.Rmd

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@ library(knitr)
2626
<!-- [![](http://cranlogs.r-pkg.org/badges/grand-total/bitfield)](https://cran.r-project.org/package=bitfield) -->
2727

2828
[![R-CMD-check](https://github.com/bitfloat/bitfield/actions/workflows/R-CMD-check.yaml/badge.svg)](https://github.com/bitfloat/bitfield/actions/workflows/R-CMD-check.yaml)
29-
[![codecov](https://codecov.io/gh/bitfloat/bitfield/graph/badge.svg?token=QZB36RION3)](https://codecov.io/gh/bitfloat/bitfield)
29+
[![codecov](https://codecov.io/gh/bitfloat/bitfield/graph/badge.svg?token=QZB36RION3)](https://app.codecov.io/gh/bitfloat/bitfield)
3030
[![Lifecycle: stable](https://img.shields.io/badge/lifecycle-stable-brightgreen.svg)](https://lifecycle.r-lib.org/articles/stages.html#stable)
3131

3232
<!-- badges: end -->

README.md

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,12 +4,14 @@
44
# bitfield <a href='https://github.com/bitfloat/bitfield/'><img src='man/figures/logo.svg' align="right" height="200" /></a>
55

66
<!-- badges: start -->
7-
<!-- [![CRAN\_Status\_Badge](http://www.r-pkg.org/badges/version/)](https://cran.r-project.org/package=) -->
7+
<!-- [![CRAN\_Status\_Badge](http://www.r-pkg.org/badges/version/bitfield)](https://cran.r-project.org/package=bitfield) -->
8+
<!-- [![](http://cranlogs.r-pkg.org/badges/grand-total/bitfield)](https://cran.r-project.org/package=bitfield) -->
89

910
[![R-CMD-check](https://github.com/bitfloat/bitfield/actions/workflows/R-CMD-check.yaml/badge.svg)](https://github.com/bitfloat/bitfield/actions/workflows/R-CMD-check.yaml)
10-
[![codecov](https://codecov.io/gh/bitfloat/bitfield/graph/badge.svg?token=QZB36RION3)](https://codecov.io/gh/bitfloat/bitfield)
11+
[![codecov](https://codecov.io/gh/bitfloat/bitfield/graph/badge.svg?token=QZB36RION3)](https://app.codecov.io/gh/bitfloat/bitfield)
1112
[![Lifecycle:
1213
stable](https://img.shields.io/badge/lifecycle-stable-brightgreen.svg)](https://lifecycle.r-lib.org/articles/stages.html#stable)
14+
1315
<!-- badges: end -->
1416

1517
## Overview

man/bf_protocol.Rd

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

man/bf_standards.Rd

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

0 commit comments

Comments
 (0)