From 0fbc1cbf173ae61bd521aadbda91911b2615d837 Mon Sep 17 00:00:00 2001 From: Aleks Bunin Date: Fri, 15 Sep 2023 07:16:21 -0400 Subject: [PATCH] docs: fix quickstart (#419) --- docs/quickstart.rst | 7 +++---- 1 file changed, 3 insertions(+), 4 deletions(-) diff --git a/docs/quickstart.rst b/docs/quickstart.rst index 2d63cafb..5c9f34da 100644 --- a/docs/quickstart.rst +++ b/docs/quickstart.rst @@ -19,13 +19,13 @@ The only required argument is the input document (here a downloaded HTML file), >>> downloaded = fetch_url('https://github.blog/2019-03-29-leader-spotlight-erin-spiceland/') # output main content and comments as plain text - >>> result = trafilatura.extract(downloaded) + >>> result = extract(downloaded) # change the output format to XML (allowing for preservation of document structure) - >>> result = trafilatura.extract(downloaded, output_format="xml") + >>> result = extract(downloaded, output_format="xml") # discard potential comment and change the output to JSON - >>> trafilatura.extract(downloaded, output_format="json", include_comments=False) + >>> extract(downloaded, output_format="json", include_comments=False) The use of fallback algorithms can also be bypassed in fast mode: @@ -75,4 +75,3 @@ Extraction options are also available on the command-line, they can be combined: For more information please refer to `usage documentation `_ and `tutorials `_. -