In edavidaja/todoordie: Write TODOs in Code That Ensure You Actually Do Them

knitr::opts_chunk$set(
  collapse = TRUE,
  comment = "#>",
  fig.path = "man/figures/README-",
  out.width = "100%"
)

Todo Or Die

Write TODOs in Code That Ensure You Actually Do Them

Installation

You can install the development version from GitHub with:

# install.packages("devtools")
devtools::install_github("edavidaja/todoordie")

Usage

Use the functions directly:

todoordie::after_date("2021-01-21", "fix after conf 2021")

todoordie::issue_closed("tidyverse/dtplyr#154", "rewrite once dtplyr supports across()")

todoordie::cran_version("plumber", "1.0.0", "no 0.* in production")

If you'd prefer for them to live in your function documentation, you can also use them as roxgyen tags:

#' sketchy function 
#'
#' @todoordie after_date 2012-12-21 if we're not all dead make this less sketchy
sketchy <- function() {}

expired todos should produce errors when you run devtools::document().

Prior art:

Ruby
Rust
Python
Elixir
Typescript

edavidaja/todoordie documentation built on Dec. 23, 2021, 11:21 p.m.