Skip to content

Commit 0423777

Browse files
committed
Clean up help documentation URLs to address a CRAN check
1 parent fbc55b2 commit 0423777

File tree

7 files changed

+49
-43
lines changed

7 files changed

+49
-43
lines changed

NEWS.md

Lines changed: 9 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -3,12 +3,17 @@
33
## Features
44

55
- Added search portals:
6-
- `search_ecosia()`: Searches on [Ecosia](https://www.ecosia.org/).
6+
- `search_ecosia()`: Searches on Ecosia.
77
([#31](https://github.com/r-assist/searcher/issues/31),
88
[#32](https://github.com/r-assist/searcher/pull/32))
99
- `search_rseek()`: Searches on [rseek](https://rseek.org/).
1010
([#32](https://github.com/r-assist/searcher/pull/33), thanks [@rossellhayes](https://github.com/rossellhayes)!)
1111

12+
## Bug Fixes
13+
14+
- Modified URLs to search engines to pass CRAN checks.
15+
- Removed documentation URLs to Ecosia search engine as they return `404: Not Found`.
16+
1217
## Deployment
1318

1419
- Updated [GitHub Actions for R](https://github.com/r-lib/actions) workflows
@@ -84,7 +89,7 @@
8489
## Features
8590

8691
- Added search portal:
87-
- `search_ixquick()`: Searches with [ixquick](https://www.ixquick.com/). (#8, #6)
92+
- `search_ixquick()`: Searches with ixquick. (#8, #6)
8893

8994
## Changes
9095

@@ -98,11 +103,11 @@
98103

99104
- Added search portal functions
100105
- `search_site()`: Looks up search portal and _then_ searches with it.
101-
- `search_google()`: Searches with [Google](https://google.com/)
106+
- `search_google()`: Searches with [Google](https://www.google.com)
102107
- `search_bing()`: Searches with [Bing](https://www.bing.com)
103108
- `search_duckduckgo()` or `search_ddg()`: Searches with [DuckDuckGo](https://duckduckgo.com/)
104109
- `search_github()` or `search_gh()`: Searches issues on [GitHub](https://github.com/)
105-
- `search_bitbucket()` or `search_bb()`: Searches issues on [BitBucket](https://bitbucket.com/)
110+
- `search_bitbucket()` or `search_bb()`: Searches issues on [BitBucket](https://bitbucket.org/)
106111
- `search_stackoverflow()` or `search_so()`: Searches questions on [StackOverflow](https://stackoverflow.com/)
107112
- Add function generator `searcher()` to create function objects that can be
108113
used as error handlers in `option(error = )` and task call-backs.

R/search-functions.R

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -157,8 +157,8 @@ searcher = function(site, keyword = getOption("searcher.default_keyword")) {
157157
#' @rdname search_site
158158
#' @export
159159
#' @section Google Search:
160-
#' The `search_google` function searches [Google](https://google.com) using:
161-
#' `https://google.com/search?q=<query>`
160+
#' The `search_google` function searches [Google](https://www.google.com/) using:
161+
#' `https://www.google.com/search?q=<query>`
162162
#'
163163
#' See \url{https://moz.com/blog/the-ultimate-guide-to-the-google-search-parameters}
164164
#' for details.
@@ -167,8 +167,8 @@ search_google = searcher("google")
167167
#' @rdname search_site
168168
#' @export
169169
#' @section Bing Search:
170-
#' The `search_bing()` function searches [Bing](https://bing.com) using:
171-
#' `https://bing.com/search?q=<query>`
170+
#' The `search_bing()` function searches [Bing](https://www.bing.com/) using:
171+
#' `https://www.bing.com/search?q=<query>`
172172
search_bing = searcher("bing")
173173

174174
#' @rdname search_site
@@ -209,10 +209,10 @@ search_sp = search_startpage
209209
#' @export
210210
#' @section Ecosia Search:
211211
#' The `search_ecosia()` function searches
212-
#' [Ecosia](https://www.ecosia.org/) using:
212+
#' Ecosia using:
213213
#' \code{https://www.ecosia.org/search?q=<query>}
214214
#'
215-
#' For additional details regarding [Ecosia](https://www.ecosia.org)'s
215+
#' For additional details regarding Ecosia's
216216
#' search interface please see:
217217
#' \url{https://ecosia.zendesk.com/hc/en-us}
218218
search_ecosia = searcher("ecosia")
@@ -299,10 +299,10 @@ search_gh = search_github
299299
#' @export
300300
#' @section BitBucket Search:
301301
#' The `search_bitbucket()` and `search_bb()` functions both search
302-
#' [BitBucket](https://bitbucket.com) using:
303-
#' \code{https://bitbucket.com/search?q=lang\%3Ar+<query>}
302+
#' [BitBucket](https://bitbucket.org) using:
303+
#' \code{https://bitbucket.org/search?q=lang\%3Ar+<query>}
304304
#'
305-
#' For additional details regarding [BitBucket](https://bitbucket.com)'s
305+
#' For additional details regarding [BitBucket](https://bitbucket.org)'s
306306
#' search interface please see:
307307
#' \url{https://confluence.atlassian.com/bitbucket/code-search-in-bitbucket-873876782.html}
308308
search_bitbucket = searcher("bb")

R/utilities.R

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -15,14 +15,14 @@
1515
#'
1616
#' @examples
1717
#' # Query Google
18-
#' browse_url("https://google.com/search?q=", "rstats is great")
18+
#' browse_url("https://www.google.com/search?q=", "rstats is great")
1919
#'
2020
#' # Generate URL for Google (do not open in a web browser)
21-
#' browse_url("https://google.com/search?q=", "rstats is great",
21+
#' browse_url("https://www.google.com/search?q=", "rstats is great",
2222
#' open_browser = FALSE)
2323
#'
2424
#' # Print out the hidden url
25-
#' print(browse_url("https://google.com/search?q=", "rstats is great",
25+
#' print(browse_url("https://www.google.com/search?q=", "rstats is great",
2626
#' open_browser = FALSE))
2727
#' @noRd
2828
browse_url = function(base,

README.Rmd

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -16,8 +16,8 @@ knitr::opts_chunk$set(
1616

1717
<!-- badges: start -->
1818
[![R build status](https://github.com/r-assist/searcher/workflows/R-CMD-check/badge.svg)](https://github.com/r-assist/searcher/actions)
19-
[![CRAN RStudio mirror downloads](http://cranlogs.r-pkg.org/badges/searcher)](http://www.r-pkg.org/pkg/searcher)
20-
[![CRAN\_Status\_Badge](http://www.r-pkg.org/badges/version/searcher)](https://cran.r-project.org/package=searcher)
19+
[![CRAN RStudio mirror downloads](https://cranlogs.r-pkg.org/badges/searcher)](https://www.r-pkg.org/pkg/searcher)
20+
[![CRAN\_Status\_Badge](https://www.r-pkg.org/badges/version/searcher)](https://cran.r-project.org/package=searcher)
2121
[![Codecov test coverage](https://codecov.io/gh/r-assist/searcher/branch/master/graph/badge.svg)](https://codecov.io/gh/r-assist/searcher?branch=master)
2222
<!-- badges: end -->
2323

@@ -62,12 +62,12 @@ library(searcher)
6262

6363
The `search_*()` functions can be used to search a query directly from _R_ on
6464
major search engines, programming help websites, and code repositories. The following search
65-
platforms are supported: [Google](https://google.com), [Bing](https://www.bing.com/),
65+
platforms are supported: [Google](https://www.google.com), [Bing](https://www.bing.com/),
6666
[DuckDuckGo](https://duckduckgo.com/), [Startpage](https://www.startpage.com/en/),
67-
[Ecosia](https://www.ecosia.org/), [rseek](https://www.rseek.org/),
67+
Ecosia, [rseek](https://rseek.org/),
6868
[Twitter](https://twitter.com/search), [StackOverflow](https://stackoverflow.com/search),
6969
[RStudio Community](https://community.rstudio.com/search),
70-
[GitHub](https://github.com/search), and [BitBucket](https://bitbucket.com/search).
70+
[GitHub](https://github.com/search), and [BitBucket](https://bitbucket.org/product/).
7171
By default, an appropriate suffix for each platform that ensures relevant
7272
results to _R_ is appended to all queries. This behavior can be disabled by
7373
using `rlang = FALSE`.
@@ -208,10 +208,10 @@ community members.
208208

209209
> R package "searcher" that automatically searches Stackoverflow for error that
210210
> you just saw in the console. Cool package, especially for those who learn R :)
211-
> https://github.com/coatless/searcher ... #r #rlang #rstats #rstudio
211+
> https://github.com/r-assist/searcher ... #r #rlang #rstats #rstudio
212212
>
213213
> --- [Paweł Przytuła](https://twitter.com/pawel_appsilon/status/1109545516264841216)
214-
> March 23th, 2019. ~292 Retweets and 876 likes
214+
> March 23th, 2019. ~292 Retweets and 876 likes (Note, URL updated to new repository location.)
215215
216216
> Did you know, using "searcher" package, you could automatically to
217217
> search stackoverflow, google, GitHub and many more sites for errors,

README.md

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -8,8 +8,8 @@
88
[![R build
99
status](https://github.com/r-assist/searcher/workflows/R-CMD-check/badge.svg)](https://github.com/r-assist/searcher/actions)
1010
[![CRAN RStudio mirror
11-
downloads](http://cranlogs.r-pkg.org/badges/searcher)](http://www.r-pkg.org/pkg/searcher)
12-
[![CRAN\_Status\_Badge](http://www.r-pkg.org/badges/version/searcher)](https://cran.r-project.org/package=searcher)
11+
downloads](https://cranlogs.r-pkg.org/badges/searcher)](https://www.r-pkg.org/pkg/searcher)
12+
[![CRAN\_Status\_Badge](https://www.r-pkg.org/badges/version/searcher)](https://cran.r-project.org/package=searcher)
1313
[![Codecov test
1414
coverage](https://codecov.io/gh/r-assist/searcher/branch/master/graph/badge.svg)](https://codecov.io/gh/r-assist/searcher?branch=master)
1515
<!-- badges: end -->
@@ -57,15 +57,14 @@ library(searcher)
5757
The `search_*()` functions can be used to search a query directly from
5858
*R* on major search engines, programming help websites, and code
5959
repositories. The following search platforms are supported:
60-
[Google](https://google.com), [Bing](https://www.bing.com/),
60+
[Google](https://www.google.com), [Bing](https://www.bing.com/),
6161
[DuckDuckGo](https://duckduckgo.com/),
62-
[Startpage](https://www.startpage.com/en/),
63-
[Ecosia](https://www.ecosia.org/), [rseek](https://www.rseek.org/),
64-
[Twitter](https://twitter.com/search),
62+
[Startpage](https://www.startpage.com/en/), Ecosia,
63+
[rseek](https://rseek.org/), [Twitter](https://twitter.com/search),
6564
[StackOverflow](https://stackoverflow.com/search), [RStudio
6665
Community](https://community.rstudio.com/search),
6766
[GitHub](https://github.com/search), and
68-
[BitBucket](https://bitbucket.com/search). By default, an appropriate
67+
[BitBucket](https://bitbucket.org/product/). By default, an appropriate
6968
suffix for each platform that ensures relevant results to *R* is
7069
appended to all queries. This behavior can be disabled by using
7170
`rlang = FALSE`.
@@ -217,12 +216,13 @@ positively received by community members.
217216

218217
> R package “searcher” that automatically searches Stackoverflow for
219218
> error that you just saw in the console. Cool package, especially for
220-
> those who learn R :) <https://github.com/coatless/searcher>\#r
219+
> those who learn R :) <https://github.com/r-assist/searcher>\#r
221220
> \#rlang \#rstats \#rstudio
222221
>
223222
> [Paweł
224223
> Przytuła](https://twitter.com/pawel_appsilon/status/1109545516264841216)
225-
> March 23th, 2019. \~292 Retweets and 876 likes
224+
> March 23th, 2019. \~292 Retweets and 876 likes (Note, URL updated to
225+
> new repository location.)
226226
227227
> Did you know, using “searcher” package, you could automatically to
228228
> search stackoverflow, google, GitHub and many more sites for errors,

man/search_site.Rd

Lines changed: 9 additions & 9 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

vignettes/search-patterns.Rmd

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -61,14 +61,15 @@ _R_-specific results. If `rlang = FALSE`, then the results are generalized.
6161
- All search engines affix `"r programming"` to the end of the query to
6262
constrain the results to be _R_-specific.
6363
- `"r programming"` was selected because it performed best when compared
64-
to `"rlang"`, `"rstats"`, and `"r language"` on [Google Trends](https://trends.google.com).
64+
to `"rlang"`, `"rstats"`, and `"r language"` on [Google Trends](https://trends.google.com/trends/).
6565
- Community Sites
6666
- [StackOverflow Search](https://stackoverflow.com/search): ` <query> + [r]`
6767
- [Twitter](https://twitter.com/search): `<query> + #rstats`
6868
- [RStudio Community](https://community.rstudio.com/search): `<query>`
69+
- [Rseek](https://rseek.org/): `<query>`
6970
- Code Repositories
7071
- [GitHub Search](https://github.com/search): `<query> language:r type:issue`
71-
- [Bitbucket Search](https://bitbucket.com/search): `<query> lang:r`
72+
- [Bitbucket Search](https://bitbucket.org/search): `<query> lang:r`
7273

7374
# General Search Tips
7475

0 commit comments

Comments
 (0)