From a83d676dbcb7a4984e888cc8f539982169346605 Mon Sep 17 00:00:00 2001 From: Davis Vaughan Date: Thu, 18 Jul 2024 11:06:34 -0400 Subject: [PATCH] Redocument with latest roxygen2 --- DESCRIPTION | 2 +- man/Date-arithmetic.Rd | 2 +- man/clock-arithmetic.Rd | 2 +- man/date_build.Rd | 2 +- man/date_time_build.Rd | 2 +- man/duration-arithmetic.Rd | 2 +- man/iso-year-week-day-arithmetic.Rd | 2 +- man/iso_year_week_day.Rd | 2 +- man/posixt-arithmetic.Rd | 2 +- man/time-point-arithmetic.Rd | 2 +- man/weekday-arithmetic.Rd | 2 +- man/year-day-arithmetic.Rd | 2 +- man/year-month-day-arithmetic.Rd | 2 +- man/year-month-weekday-arithmetic.Rd | 2 +- man/year-quarter-day-arithmetic.Rd | 2 +- man/year-week-day-arithmetic.Rd | 2 +- man/year_day.Rd | 2 +- man/year_month_day.Rd | 2 +- man/year_month_weekday.Rd | 2 +- man/year_quarter_day.Rd | 2 +- man/year_week_day.Rd | 2 +- 21 files changed, 21 insertions(+), 21 deletions(-) diff --git a/DESCRIPTION b/DESCRIPTION index c9bda8e2..54af93ea 100644 --- a/DESCRIPTION +++ b/DESCRIPTION @@ -44,4 +44,4 @@ Config/testthat/edition: 3 Encoding: UTF-8 LazyData: true Roxygen: list(markdown = TRUE) -RoxygenNote: 7.2.3 +RoxygenNote: 7.3.2 diff --git a/man/Date-arithmetic.Rd b/man/Date-arithmetic.Rd index d8ac915f..e62ffd61 100644 --- a/man/Date-arithmetic.Rd +++ b/man/Date-arithmetic.Rd @@ -91,7 +91,7 @@ Adding a single quarter with \code{add_quarters()} is equivalent to adding 3 months. \code{x} and \code{n} are recycled against each other using -\link[vctrs:vector_recycling_rules]{tidyverse recycling rules}. +\link[vctrs:theory-faq-recycling]{tidyverse recycling rules}. Only calendrical based arithmetic has the potential to generate invalid dates. Time point based arithmetic, like adding days, will always generate diff --git a/man/clock-arithmetic.Rd b/man/clock-arithmetic.Rd index 5fb0abbd..c1a0d9d8 100644 --- a/man/clock-arithmetic.Rd +++ b/man/clock-arithmetic.Rd @@ -98,7 +98,7 @@ native R date or date-time type: } \details{ \code{x} and \code{n} are recycled against each other using -\link[vctrs:vector_recycling_rules]{tidyverse recycling rules}. +\link[vctrs:theory-faq-recycling]{tidyverse recycling rules}. Months and years are considered "irregular" because some months have more days then others (28, 29, 30, or 31), and some years have more days than diff --git a/man/date_build.Rd b/man/date_build.Rd index 19e0cd5a..28054298 100644 --- a/man/date_build.Rd +++ b/man/date_build.Rd @@ -58,7 +58,7 @@ A Date. } \details{ Components are recycled against each other using -\link[vctrs:vector_recycling_rules]{tidyverse recycling rules}. +\link[vctrs:theory-faq-recycling]{tidyverse recycling rules}. } \examples{ date_build(2019) diff --git a/man/date_time_build.Rd b/man/date_time_build.Rd index b28b3034..7b08ed7c 100644 --- a/man/date_time_build.Rd +++ b/man/date_time_build.Rd @@ -150,7 +150,7 @@ To build a POSIXct, it is required that you specify the \code{zone}. } \details{ Components are recycled against each other using -\link[vctrs:vector_recycling_rules]{tidyverse recycling rules}. +\link[vctrs:theory-faq-recycling]{tidyverse recycling rules}. } \examples{ # The zone argument is required! diff --git a/man/duration-arithmetic.Rd b/man/duration-arithmetic.Rd index 8c3d6f8d..1e062c06 100644 --- a/man/duration-arithmetic.Rd +++ b/man/duration-arithmetic.Rd @@ -85,7 +85,7 @@ add a chronological duration to a calendrical duration documentation on the \link[=duration-helper]{duration helper} page. \code{x} and \code{n} are recycled against each other using -\link[vctrs:vector_recycling_rules]{tidyverse recycling rules}. +\link[vctrs:theory-faq-recycling]{tidyverse recycling rules}. } \examples{ x <- duration_seconds(5) diff --git a/man/iso-year-week-day-arithmetic.Rd b/man/iso-year-week-day-arithmetic.Rd index 977dd51d..9c594193 100644 --- a/man/iso-year-week-day-arithmetic.Rd +++ b/man/iso-year-week-day-arithmetic.Rd @@ -40,7 +40,7 @@ undefined, as the 53rd ISO week of 2019 doesn't exist to begin with. } \details{ \code{x} and \code{n} are recycled against each other using -\link[vctrs:vector_recycling_rules]{tidyverse recycling rules}. +\link[vctrs:theory-faq-recycling]{tidyverse recycling rules}. } \examples{ x <- iso_year_week_day(2019, 1, 1) diff --git a/man/iso_year_week_day.Rd b/man/iso_year_week_day.Rd index c369eb0a..16ac977a 100644 --- a/man/iso_year_week_day.Rd +++ b/man/iso_year_week_day.Rd @@ -71,7 +71,7 @@ and week day. } \details{ Fields are recycled against each other using -\link[vctrs:vector_recycling_rules]{tidyverse recycling rules}. +\link[vctrs:theory-faq-recycling]{tidyverse recycling rules}. Fields are collected in order until the first \code{NULL} field is located. No fields after the first \code{NULL} field are used. diff --git a/man/posixt-arithmetic.Rd b/man/posixt-arithmetic.Rd index 4ccde349..a347bfe4 100644 --- a/man/posixt-arithmetic.Rd +++ b/man/posixt-arithmetic.Rd @@ -170,7 +170,7 @@ Adding a single quarter with \code{add_quarters()} is equivalent to adding 3 months. \code{x} and \code{n} are recycled against each other using -\link[vctrs:vector_recycling_rules]{tidyverse recycling rules}. +\link[vctrs:theory-faq-recycling]{tidyverse recycling rules}. Calendrical based arithmetic has the potential to generate invalid dates (like the 31st of February), nonexistent times (due to daylight saving diff --git a/man/time-point-arithmetic.Rd b/man/time-point-arithmetic.Rd index f3d98d9f..e05f731f 100644 --- a/man/time-point-arithmetic.Rd +++ b/man/time-point-arithmetic.Rd @@ -73,7 +73,7 @@ or years, convert to a calendar type with a converter like } \details{ \code{x} and \code{n} are recycled against each other using -\link[vctrs:vector_recycling_rules]{tidyverse recycling rules}. +\link[vctrs:theory-faq-recycling]{tidyverse recycling rules}. } \examples{ library(magrittr) diff --git a/man/weekday-arithmetic.Rd b/man/weekday-arithmetic.Rd index 6989309b..a65c1f09 100644 --- a/man/weekday-arithmetic.Rd +++ b/man/weekday-arithmetic.Rd @@ -36,7 +36,7 @@ usage. } \details{ \code{x} and \code{n} are recycled against each other using -\link[vctrs:vector_recycling_rules]{tidyverse recycling rules}. +\link[vctrs:theory-faq-recycling]{tidyverse recycling rules}. } \examples{ saturday <- weekday(clock_weekdays$saturday) diff --git a/man/year-day-arithmetic.Rd b/man/year-day-arithmetic.Rd index 0678bd24..75eaf71e 100644 --- a/man/year-day-arithmetic.Rd +++ b/man/year-day-arithmetic.Rd @@ -36,7 +36,7 @@ first convert to a time point with \code{\link[=as_naive_time]{as_naive_time()}} } \details{ \code{x} and \code{n} are recycled against each other using -\link[vctrs:vector_recycling_rules]{tidyverse recycling rules}. +\link[vctrs:theory-faq-recycling]{tidyverse recycling rules}. } \examples{ x <- year_day(2019, 10) diff --git a/man/year-month-day-arithmetic.Rd b/man/year-month-day-arithmetic.Rd index 19c8d8e5..b6973700 100644 --- a/man/year-month-day-arithmetic.Rd +++ b/man/year-month-day-arithmetic.Rd @@ -47,7 +47,7 @@ Adding a single quarter with \code{add_quarters()} is equivalent to adding 3 months. \code{x} and \code{n} are recycled against each other using -\link[vctrs:vector_recycling_rules]{tidyverse recycling rules}. +\link[vctrs:theory-faq-recycling]{tidyverse recycling rules}. } \examples{ x <- year_month_day(2019, 1, 1) diff --git a/man/year-month-weekday-arithmetic.Rd b/man/year-month-weekday-arithmetic.Rd index e2ac781a..f622c942 100644 --- a/man/year-month-weekday-arithmetic.Rd +++ b/man/year-month-weekday-arithmetic.Rd @@ -48,7 +48,7 @@ Adding a single quarter with \code{add_quarters()} is equivalent to adding 3 months. \code{x} and \code{n} are recycled against each other using -\link[vctrs:vector_recycling_rules]{tidyverse recycling rules}. +\link[vctrs:theory-faq-recycling]{tidyverse recycling rules}. } \examples{ # 2nd Friday in January, 2019 diff --git a/man/year-quarter-day-arithmetic.Rd b/man/year-quarter-day-arithmetic.Rd index cbedce12..1ad7fb6c 100644 --- a/man/year-quarter-day-arithmetic.Rd +++ b/man/year-quarter-day-arithmetic.Rd @@ -41,7 +41,7 @@ arithmetic, first convert to a time point with \code{\link[=as_naive_time]{as_na } \details{ \code{x} and \code{n} are recycled against each other using -\link[vctrs:vector_recycling_rules]{tidyverse recycling rules}. +\link[vctrs:theory-faq-recycling]{tidyverse recycling rules}. } \examples{ x <- year_quarter_day(2019, 1:3) diff --git a/man/year-week-day-arithmetic.Rd b/man/year-week-day-arithmetic.Rd index fffdda4b..d3217aa0 100644 --- a/man/year-week-day-arithmetic.Rd +++ b/man/year-week-day-arithmetic.Rd @@ -40,7 +40,7 @@ would be undefined. } \details{ \code{x} and \code{n} are recycled against each other using -\link[vctrs:vector_recycling_rules]{tidyverse recycling rules}. +\link[vctrs:theory-faq-recycling]{tidyverse recycling rules}. } \examples{ x <- year_week_day(2019, 1, 1) diff --git a/man/year_day.Rd b/man/year_day.Rd index 8f723e52..55bf49d5 100644 --- a/man/year_day.Rd +++ b/man/year_day.Rd @@ -63,7 +63,7 @@ year and day of the year. } \details{ Fields are recycled against each other using -\link[vctrs:vector_recycling_rules]{tidyverse recycling rules}. +\link[vctrs:theory-faq-recycling]{tidyverse recycling rules}. Fields are collected in order until the first \code{NULL} field is located. No fields after the first \code{NULL} field are used. diff --git a/man/year_month_day.Rd b/man/year_month_day.Rd index 88e5accb..14d64ee1 100644 --- a/man/year_month_day.Rd +++ b/man/year_month_day.Rd @@ -70,7 +70,7 @@ Gregorian year, month, day, and time of day components. } \details{ Fields are recycled against each other using -\link[vctrs:vector_recycling_rules]{tidyverse recycling rules}. +\link[vctrs:theory-faq-recycling]{tidyverse recycling rules}. Fields are collected in order until the first \code{NULL} field is located. No fields after the first \code{NULL} field are used. diff --git a/man/year_month_weekday.Rd b/man/year_month_weekday.Rd index 0b34747e..24c0d3c0 100644 --- a/man/year_month_weekday.Rd +++ b/man/year_month_weekday.Rd @@ -79,7 +79,7 @@ of the month. } \details{ Fields are recycled against each other using -\link[vctrs:vector_recycling_rules]{tidyverse recycling rules}. +\link[vctrs:theory-faq-recycling]{tidyverse recycling rules}. Fields are collected in order until the first \code{NULL} field is located. No fields after the first \code{NULL} field are used. diff --git a/man/year_quarter_day.Rd b/man/year_quarter_day.Rd index b84b8e26..da4fe6c2 100644 --- a/man/year_quarter_day.Rd +++ b/man/year_quarter_day.Rd @@ -78,7 +78,7 @@ month the fiscal year \code{start}s in. } \details{ Fields are recycled against each other using -\link[vctrs:vector_recycling_rules]{tidyverse recycling rules}. +\link[vctrs:theory-faq-recycling]{tidyverse recycling rules}. Fields are collected in order until the first \code{NULL} field is located. No fields after the first \code{NULL} field are used. diff --git a/man/year_week_day.Rd b/man/year_week_day.Rd index c8a6c17f..be9df8c6 100644 --- a/man/year_week_day.Rd +++ b/man/year_week_day.Rd @@ -86,7 +86,7 @@ week-based data. } \details{ Fields are recycled against each other using -\link[vctrs:vector_recycling_rules]{tidyverse recycling rules}. +\link[vctrs:theory-faq-recycling]{tidyverse recycling rules}. Fields are collected in order until the first \code{NULL} field is located. No fields after the first \code{NULL} field are used.