search

r-lib / rprojroot

Finding files in project subdirectories
https://rprojroot.r-lib.org/
Other
149 stars 23 forks source link

Documentation of criteria: wrong names? #49

Closed florisvdh closed 3 years ago

florisvdh commented 4 years ago

In the 'details' section of criteria documentation, a few invalid (old?) names are still in use:

is_git_project looks for a .git directory.

is_svn_project looks for a .svn directory.

is_vcs_project looks for the root of a version control system, currently only Git and SVN are supported.

These should have the suffix _root.

─ Session info ───────────────────────────────────────────────────────────────────────
 setting  value                       
 version  R version 4.0.2 (2020-06-22)
 os       Linux Mint 20               
 system   x86_64, linux-gnu           
 ui       RStudio                     
 language nl_BE:nl                    
 collate  nl_BE.UTF-8                 
 ctype    nl_BE.UTF-8                 
 tz       Europe/Brussels             
 date     2020-09-08                  

─ Packages ───────────────────────────────────────────────────────────────────────────
 package   * version date       lib source        
 backports   1.1.9   2020-08-24 [1] CRAN (R 4.0.2)
 rprojroot * 1.3-2   2018-01-03 [1] CRAN (R 4.0.2)

[1] /home/floris/lib/R/library
krlmlr commented 3 years ago

Fixed in the dev documentation, soon on CRAN: https://rprojroot.r-lib.org/dev/reference/criteria.html .

github-actions[bot] commented 2 years ago

This old thread has been automatically locked. If you think you have found something related to this, please open a new issue and link to this old issue if necessary.