diff --git a/README.md b/README.md index 23714f4..3f44251 100644 --- a/README.md +++ b/README.md @@ -1,7 +1,8 @@ # felp felp is a short of **f**unction h**elp**. -This package provides functions to print source and help of a function simultaneously. +This package provides functions to print +source and help of a function simultaneously. ## Installation @@ -17,11 +18,18 @@ devtools::install_github("atusy/felp") Following codes provide same results to print help and source of `help`. ``` r -help -utils::help +?help felp(help) felp("help") felp(utils::help) felp(help, utils) ``` +`print.function()` is also implemented to give the same results above +just simply entering objects name like below. +However, `print.function()` is not exported due to a conflict with +RStudio's autocompletions. +```r +help +utils::help +```