Skip to content

Commit f04cb86

Browse files
committed
Clarify status of html() function
Fixes #266
1 parent 5983475 commit f04cb86

File tree

5 files changed

+6
-13
lines changed

5 files changed

+6
-13
lines changed

R/parse.R

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
#' Parse an HTML page.
22
#'
3-
#' html is deprecated: please use `read_html`() instead.
3+
#' html is deprecated: please use `xml2::read_html()` instead.
44
#'
55
#' @param x A url, a local path, a string containing html, or a response from
66
#' an httr request.
@@ -9,7 +9,7 @@
99
#' @param encoding Specify encoding of document. See [iconvlist()]
1010
#' for complete list. If you have problems determining the correct encoding,
1111
#' try [stringi::stri_enc_detect()]
12-
#' @keywords deprecated
12+
#' @keywords internal
1313
#' @export
1414
#' @examples
1515
#' # From a url:

README.Rmd

Lines changed: 1 addition & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -62,10 +62,7 @@ devtools::install_github("tidyverse/rvest")
6262

6363
## Key functions
6464

65-
The most important functions in rvest are:
66-
67-
* Create an html document from a url, a file on disk or a string containing
68-
html with `read_html()`.
65+
Once you have read a HTML document with `read_html()`, you can:
6966

7067
* Select parts of a document using CSS selectors: `html_nodes(doc, "table td")`
7168
(or if you've a glutton for punishment, use XPath selectors with

README.md

Lines changed: 1 addition & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -64,10 +64,7 @@ devtools::install_github("tidyverse/rvest")
6464

6565
## Key functions
6666

67-
The most important functions in rvest are:
68-
69-
- Create an html document from a url, a file on disk or a string
70-
containing html with `read_html()`.
67+
Once you have read a HTML document with `read_html()`, you can:
7168

7269
- Select parts of a document using CSS selectors: `html_nodes(doc,
7370
"table td")` (or if you’ve a glutton for punishment, use XPath

_pkgdown.yml

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,6 @@ template:
1010
reference:
1111
- title: Extract data from HTML
1212
contents:
13-
- html
1413
- html_form
1514
- html_nodes
1615
- html_table

man/html.Rd

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

0 commit comments

Comments
 (0)