document arg

spectral-cockpit · Nov 11, 2023 · e14581a · e14581a
1 parent 1edf5b6
commit e14581a
Show file tree

Hide file tree

Showing 2 changed files with 3 additions and 1 deletion.
diff --git a/R/read_bin_types.R b/R/read_bin_types.R
@@ -42,8 +42,8 @@ read_signed_int <- function(raw, cursor, n = 1L) {
 }
 
 #' read character from binary
-#'
 #' @inheritParams read_unsigned_int
+#' @param n_char integer with number of desired characters to read from raw
 #' @param encoding encoding to assign character strings that are read. Default
 #' is `"latin1"`., which will use Windows Latin 1 (ANSI) encoding. This is
 #' how Bruker software OPUS is assumed to commonly store strings.

diff --git a/man/read_character.Rd b/man/read_character.Rd