Merge pull request #38 from rlskoeser/patch-1

AlbertWeichselbraun · web-flow · commit 025169b232f3 · 2021-09-06T11:49:00.000+02:00
Minor documentation edits
diff --git a/README.rst b/README.rst
@@ -150,7 +150,7 @@ The inscript.py command line client supports the following parameters::
     -l, --display-link-targets
                           Display link targets (default:false).
     -a, --display-anchor-urls
-                          Deduplicate image captions (default:false).
+                          Display anchor urls (default:false).
     -r ANNOTATION_RULES, --annotation-rules ANNOTATION_RULES
                           Path to an optional JSON file containing rules for annotating the retrieved text.
     -p POSTPROCESSOR, --postprocessor POSTPROCESSOR
@@ -172,14 +172,16 @@ convert the file to text and save the output to output.txt::
    
 convert HTML provided via stdin and save the output to output.txt::
 
-  $ echo '<body><p>Make it so!</p>></body>' | inscript.py -o output.txt 
+  $ echo '<body><p>Make it so!</p></body>' | inscript.py -o output.txt 
 
 
 HTML to annotated text conversion
 ---------------------------------
-convert and annotate HTML from a Web page using the provided annotation rules::
+convert and annotate HTML from a Web page using the provided annotation rules. 
+
+Download the example `annotation-profile.json <https://github.com/weblyzard/inscriptis/blob/master/examples/annotation-profile.json>`_ and save it to your working directory::
 
-  $ inscript.py https://www.fhgr.ch -r ./examples/annotation-profile.json
+  $ inscript.py https://www.fhgr.ch -r annotation-profile.json
 
 The annotation rules are specified in `annotation-profile.json`:
 
diff --git a/scripts/inscript.py b/scripts/inscript.py
@@ -55,7 +55,7 @@ def get_parser():
                         help='Display link targets (default:false).')
     parser.add_argument('-a', '--display-anchor-urls',
                         action='store_true', default=False,
-                        help='Deduplicate image captions (default:false).')
+                        help='Display anchor urls (default:false).')
     parser.add_argument('-r', '--annotation-rules', default=None,
                         help='Path to an optional JSON file containing rules '
                              'for annotating the retrieved text.')
