Skip to content

tcholewik/todor

 
 

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

16 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

TODOr

This is a simple addin to RStudio, which finds all TODO, FIXME, CHANGED etc. comments in your project and shows them as a markers list.

Installation

devtools::install_github("dokato/todor")

How to use it?

When you write an R package, sometimes it's useful to note in comments that there is a place for improvement.

simple_function <- function(a, b) {
  # TODO in the future it should be multiplication
  a + b
}

With TODOr, detecting such a places in the forest of code lines is simple. There are several options to do so. You can click at "Addins" button in the top panel and select "Find TODOs" from the list of possible options:

Addins panel

It is also possible to call todor directly from RStudio console:

> todor::todor()

or you can call:

> todor::todor(c("TODO"))

to limit todor for detecting only "TODO" tags.

Regardless of the option that you have chosen, as a result you should see the Markers tab next to your console window in RStudio.

TODO Markers

What it can detect?

  • FIXME
  • TODO
  • CHANGED
  • IDEA
  • HACK
  • NOTE
  • REVIEW
  • BUG
  • QUESTION
  • COMBAK
  • TEMP

About

TODOr

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors

Languages

  • R 100.0%