Skip to content

Commit 4f98624

Browse files
committed
docs: use brackets around type annotations
1 parent fde39ff commit 4f98624

File tree

8 files changed

+12
-12
lines changed

8 files changed

+12
-12
lines changed

R/interest-rate.R

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@
77
#' input market prices, which are indicative quotations obtained by the Federal Reserve
88
#' Bank of New York at approximately 3:30 PM each business day.
99
#'
10-
#' @param date `character(1)` or `numeric(1)` date in format yyyy or yyyymm.
10+
#' @param date (`character(1)` | `numeric(1)`) date in format yyyy or yyyymm.
1111
#' If `NULL`, all data is returned. Default `NULL`.
1212
#' @returns A `data.table()` containing the rates or `NULL` when no entries were found.
1313
#' @source <https://home.treasury.gov/treasury-daily-interest-rate-xml-feed>

R/yield-curve.R

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -7,14 +7,14 @@
77
#' The Treasury Breakeven Inflation Curve (TBI curve) is derived from the TNC and TRC
88
#' yield curves combined.
99
#'
10-
#' @param x `character(1)`. Must be one of the following options:
10+
#' @param x (`character(1)`) one of the following options:
1111
#' * `"hqm"`: The Treasury High Quality Market (HQM) Corporate Bond Yield Curve.
1212
#' * `"tnc"`: The Treasury Nominal Coupon-Issue (TNC) Yield Curve.
1313
#' * `"trc"`: The Treasury Real Coupon-Issue (TRC) Yield Curve.
1414
#' * `"tbi"`: The Treasury Breakeven Inflation (TBI) Curve.
15-
#' @param type `character(1)`. Either `"monthly"` or `"end-of-month"`.
15+
#' @param type (`character(1)`) either `"monthly"` or `"end-of-month"`.
1616
#' Default is `"monthly"`.
17-
#' @param year `integer(1)`. Year to download. Default is `NULL`.
17+
#' @param year (`integer(1)`) year to download. Default is `NULL`.
1818
#' If `NULL`, then all available years are downloaded.
1919
#' @returns
2020
#' A `data.table()` containing the treasury rates.

man/tr_bill_rates.Rd

Lines changed: 1 addition & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

man/tr_curve_rate.Rd

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

man/tr_long_term_rate.Rd

Lines changed: 1 addition & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

man/tr_real_long_term.Rd

Lines changed: 1 addition & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

man/tr_real_yield_curve.Rd

Lines changed: 1 addition & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

man/tr_yield_curve.Rd

Lines changed: 1 addition & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

0 commit comments

Comments
 (0)