fix typos in docs

tiaquistera · Sep 28, 2022 · 5bc24bd · 5bc24bd
1 parent 4b85bd5
commit 5bc24bd
Show file tree

Hide file tree

Showing 15 changed files with 35 additions and 35 deletions.
diff --git a/README.md b/README.md
@@ -159,8 +159,8 @@ Table of Contents
          * [Query Params](#query-params)
          * [Basic Authentication](#basic-authentication)
       * [Sending Data](#sending-data)
-         * [Sending HTML Form Datas](#sending-html-form-datas)
-         * [Sending Multipart Form Datas](#sending-multipart-form-datas)
+         * [Sending HTML Form Data](#sending-html-form-data)
+         * [Sending Multipart Form Data](#sending-multipart-form-data)
          * [Posting a JSON Body](#posting-a-json-body)
          * [Templating a JSON / XML Body](#templating-a-json--xml-body)
       * [Testing Response](#testing-response)
@@ -298,7 +298,7 @@ you could use [`-u/--user` option].
 
 ## Sending Data
 
-### Sending HTML Form Datas
+### Sending HTML Form Data
 
 ```hurl
 POST https://example.org/contact
@@ -311,7 +311,7 @@ number: 33611223344
 
 [Doc](https://hurl.dev/docs/request.html#form-parameters)
 
-### Sending Multipart Form Datas
+### Sending Multipart Form Data
 
 ```hurl
 POST https://example.org/upload
@@ -436,7 +436,7 @@ jsonpath "$.hasDevice" == false
 jsonpath "$.links" count == 12
 jsonpath "$.state" != null
 jsonpath "$.order" matches "^order-\\d{8}$"
-jsonpath "$.order" matches /^order-\d{8}$/     # Alternative syntax with regex litteral
+jsonpath "$.order" matches /^order-\d{8}$/     # Alternative syntax with regex literal
 ```
 
 [Doc](https://hurl.dev/docs/asserting-response.html#jsonpath-assert)
@@ -738,7 +738,7 @@ Option | Description
 <a href="#cookie" id="cookie"><code>-b, --cookie &lt;file&gt;</code></a> | Read cookies from file (using the Netscape cookie file format).<br/><br/>Combined with [`-c, --cookie-jar`](#cookie-jar), you can simulate a cookie storage between successive Hurl runs.<br/>
 <a href="#cookie-jar" id="cookie-jar"><code>-c, --cookie-jar &lt;file&gt;</code></a> | Write cookies to FILE after running the session (only for one session).<br/>The file will be written using the Netscape cookie file format.<br/><br/>Combined with [`-b, --cookie`](#cookie), you can simulate a cookie storage between successive Hurl runs.<br/>
 <a href="#fail-at-end" id="fail-at-end"><code>--fail-at-end</code></a> | Continue executing requests to the end of the Hurl file even when an assert error occurs.<br/>By default, Hurl exits after an assert error in the HTTP response.<br/><br/>Note that this option does not affect the behavior with multiple input Hurl files.<br/><br/>All the input files are executed independently. The result of one file does not affect the execution of the other Hurl files.<br/>
-<a href="#file-root" id="file-root"><code>--file-root &lt;dir&gt;</code></a> | Set root filesystem to import files in Hurl. This is used for both files in multipart form data and request body.<br/>When this is not explicitly defined, the files are relative to the current directory in which Hurl is running.<br/>
+<a href="#file-root" id="file-root"><code>--file-root &lt;dir&gt;</code></a> | Set root file system to import files in Hurl. This is used for both files in multipart form data and request body.<br/>When this is not explicitly defined, the files are relative to the current directory in which Hurl is running.<br/>
 <a href="#location" id="location"><code>-L, --location</code></a> | Follow redirect. To limit the amount of redirects to follow use the [`--max-redirs`](#max-redirs) option<br/>
 <a href="#glob" id="glob"><code>--glob &lt;glob&gt;</code></a> | Specify input files that match the given glob pattern.<br/><br/>Multiple glob flags may be used. This flag supports common Unix glob patterns like *, ? and []. <br/>However, to avoid your shell accidentally expanding glob patterns before Hurl handles them, you must use single quotes or double quotes around each pattern.<br/>
 <a href="#include" id="include"><code>-i, --include</code></a> | Include the HTTP headers in the output (last entry).<br/>
@@ -985,5 +985,5 @@ Please follow the [contrib on Windows section].
 [install]: https://www.rust-lang.org/tools/install
 [Rust]: https://www.rust-lang.org
 [contrib on Windows section]: https://github.com/Orange-OpenSource/hurl/blob/master/contrib/windows/README.md
-[NixOS / Nix package]: https://search.nixos.org/packages?channel=21.11&from=0&size=1&sort=relevance&type=packages&query=hurl
+[NixOS / Nix package]: https://search.nixos.org/packages?from=0&size=1&sort=relevance&type=packages&query=hurl
 
diff --git a/docs/asserting-response.md b/docs/asserting-response.md
@@ -619,7 +619,7 @@ or
 ~~~
 
 
-Finaly, raw string can be used without any newline:
+Finally, raw string can be used without any newline:
 
 ~~~
 ```line``` 

diff --git a/docs/frequently-asked-questions.md b/docs/frequently-asked-questions.md
@@ -26,7 +26,7 @@ We think that Hurl has some advantages compared to similar tools.
 
 Hurl is foremost a command line tool and should be easy to use on a local computer, or in a CI/CD pipeline. Some
 tools in the same space as Hurl ([Postman] for instance), are GUI oriented, and we find it
-less attractive than CLI. As a command line tool, Hurl can be used to get HTTP datas (like [curl]),
+less attractive than CLI. As a command line tool, Hurl can be used to get HTTP data (like [curl]),
 but also as a test tool for HTTP sessions, or even as documentation.
 
 Having a text based [file format] is another advantage. The Hurl format is simple,

diff --git a/docs/manual.md b/docs/manual.md
@@ -154,7 +154,7 @@ Option | Description
 <a href="#cookie" id="cookie"><code>-b, --cookie &lt;file&gt;</code></a> | Read cookies from file (using the Netscape cookie file format).<br/><br/>Combined with [`-c, --cookie-jar`](#cookie-jar), you can simulate a cookie storage between successive Hurl runs.<br/>
 <a href="#cookie-jar" id="cookie-jar"><code>-c, --cookie-jar &lt;file&gt;</code></a> | Write cookies to FILE after running the session (only for one session).<br/>The file will be written using the Netscape cookie file format.<br/><br/>Combined with [`-b, --cookie`](#cookie), you can simulate a cookie storage between successive Hurl runs.<br/>
 <a href="#fail-at-end" id="fail-at-end"><code>--fail-at-end</code></a> | Continue executing requests to the end of the Hurl file even when an assert error occurs.<br/>By default, Hurl exits after an assert error in the HTTP response.<br/><br/>Note that this option does not affect the behavior with multiple input Hurl files.<br/><br/>All the input files are executed independently. The result of one file does not affect the execution of the other Hurl files.<br/>
-<a href="#file-root" id="file-root"><code>--file-root &lt;dir&gt;</code></a> | Set root filesystem to import files in Hurl. This is used for both files in multipart form data and request body.<br/>When this is not explicitly defined, the files are relative to the current directory in which Hurl is running.<br/>
+<a href="#file-root" id="file-root"><code>--file-root &lt;dir&gt;</code></a> | Set root file system to import files in Hurl. This is used for both files in multipart form data and request body.<br/>When this is not explicitly defined, the files are relative to the current directory in which Hurl is running.<br/>
 <a href="#location" id="location"><code>-L, --location</code></a> | Follow redirect. To limit the amount of redirects to follow use the [`--max-redirs`](#max-redirs) option<br/>
 <a href="#glob" id="glob"><code>--glob &lt;glob&gt;</code></a> | Specify input files that match the given glob pattern.<br/><br/>Multiple glob flags may be used. This flag supports common Unix glob patterns like *, ? and []. <br/>However, to avoid your shell accidentally expanding glob patterns before Hurl handles them, you must use single quotes or double quotes around each pattern.<br/>
 <a href="#include" id="include"><code>-i, --include</code></a> | Include the HTTP headers in the output (last entry).<br/>

diff --git a/docs/manual/hurl.1 b/docs/manual/hurl.1
@@ -1,4 +1,4 @@
-.TH hurl 1 "13 Sep 2022" "hurl 1.7.0" " Hurl Manual"
+.TH hurl 1 "25 Sep 2022" "hurl 1.8.0-SNAPSHOT" " Hurl Manual"
 .SH NAME
 
 hurl - run and test HTTP requests.
@@ -167,7 +167,7 @@ All the input files are executed independently. The result of one file does not
 
 .IP "--file-root <dir> "
 
-Set root filesystem to import files in Hurl. This is used for both files in multipart form data and request body.
+Set root file system to import files in Hurl. This is used for both files in multipart form data and request body.
 When this is not explicitly defined, the files are relative to the current directory in which Hurl is running.
 
 .IP "-L, --location "

diff --git a/docs/manual/hurl.md b/docs/manual/hurl.md
@@ -186,7 +186,7 @@ All the input files are executed independently. The result of one file does not
 
 ### --file-root <dir> {#file-root}
 
-Set root filesystem to import files in Hurl. This is used for both files in multipart form data and request body.
+Set root file system to import files in Hurl. This is used for both files in multipart form data and request body.
 When this is not explicitly defined, the files are relative to the current directory in which Hurl is running.
 
 ### -L, --location {#location}

diff --git a/docs/manual/hurlfmt.1 b/docs/manual/hurlfmt.1
@@ -1,4 +1,4 @@
-.TH hurl 1 "13 Sep 2022" "hurl 1.7.0" " Hurl Manual"
+.TH hurl 1 "25 Sep 2022" "hurl 1.8.0-SNAPSHOT" " Hurl Manual"
 .SH NAME
 
 hurlfmt - format Hurl files

diff --git a/docs/request.md b/docs/request.md
@@ -4,7 +4,7 @@
 
 Request describes an HTTP request: a mandatory [method] and [url], followed by optional [headers].
 
-Then, [query parameters], [form parameters], [multipart form datas], [cookies] and
+Then, [query parameters], [form parameters], [multipart form data], [cookies] and
 [basic authentication] can be used to configure the HTTP request.
 
 Finally, an optional [body] can be used to configure the HTTP request body.
@@ -115,7 +115,7 @@ id: 4567
 order: newest
 ```
 
-The last optional part of a request configuration is the request [body]. Request body must be the last paremeter of a request
+The last optional part of a request configuration is the request [body]. Request body must be the last parameter of a request
 (after [headers] and request sections). Like headers, [body] have no explicit marker:
 
 ```hurl
@@ -435,7 +435,7 @@ or
 ~~~
 
 
-Finaly, raw string can be used without any newline:
+Finally, raw string can be used without any newline:
 
 ~~~
 ```line``` 
@@ -516,7 +516,7 @@ very-verbose: true      # allow more verbose output
 [Headers]: #headers
 [query parameters]: #query-parameters
 [form parameters]: #form-parameters
-[multipart form datas]: #multipart-form-data
+[multipart form data]: #multipart-form-data
 [cookies]: #cookies
 [basic authentication]: #basic-authentication
 [body]: #body

diff --git a/docs/running-tests.md b/docs/running-tests.md
@@ -57,7 +57,7 @@ Failed files:    1 (50.0%)
 Duration:        499 ms
 ```
 
-You can use [`--glob` option] to test files that match a given patten:
+You can use [`--glob` option] to test files that match a given pattern:
 
 ```shell
 $ hurl --test --glob "test/integration/**/*.hurl"

diff --git a/docs/samples.md b/docs/samples.md
@@ -87,7 +87,7 @@ you could use [`-u/--user` option].
 
 ## Sending Data
 
-### Sending HTML Form Datas
+### Sending HTML Form Data
 
 ```hurl
 POST https://example.org/contact
@@ -100,7 +100,7 @@ number: 33611223344
 
 [Doc](/docs/request.md#form-parameters)
 
-### Sending Multipart Form Datas
+### Sending Multipart Form Data
 
 ```hurl
 POST https://example.org/upload
@@ -225,7 +225,7 @@ jsonpath "$.hasDevice" == false
 jsonpath "$.links" count == 12
 jsonpath "$.state" != null
 jsonpath "$.order" matches "^order-\\d{8}$"
-jsonpath "$.order" matches /^order-\d{8}$/     # Alternative syntax with regex litteral
+jsonpath "$.order" matches /^order-\d{8}$/     # Alternative syntax with regex literal
 ```
 
 [Doc](/docs/asserting-response.md#jsonpath-assert)

diff --git a/docs/tutorial/captures.md b/docs/tutorial/captures.md
@@ -58,7 +58,7 @@ question4: 0fec576c
 HTTP/1.1 302
 ```
 
-> When sending form datas with a Form parameters section, you don't need to set the
+> When sending form data with a Form parameters section, you don't need to set the
 > `Content-Type` HTTP header: Hurl enfers that the content type of the request is `application/x-www-form-urlencoded`.
 
 2. Run `create-quiz.hurl`:

diff --git a/docs/tutorial/chaining-requests.md b/docs/tutorial/chaining-requests.md
@@ -167,7 +167,7 @@ jsonpath "$[0].title" == "What is a pennyroyal?"
 > in our Quiz application. That's something you don't want to do when building
 > your application, you want to build an app production ready. A better way to
 > do this should have been to expose a "debug" or "integration" mode on our app
-> positioned by environnement variables. If our app is launched in "integration" mode,
+> positioned by environment variables. If our app is launched in "integration" mode,
 > mocked data is used and asserts can be tested on known values. Our app could also use
 > a mocked database, configured in our tests suits.
 

diff --git a/docs/tutorial/ci-cd-integration.md b/docs/tutorial/ci-cd-integration.md
@@ -117,7 +117,7 @@ the container and waits for a `200 OK` response.
 
 Next, we're going to add our Hurl tests to the script.
 
-6. Modify `bin/integration.sh` to add integraion tests:
+6. Modify `bin/integration.sh` to add integration tests:
 
 ```bash
 #!/bin/bash

diff --git a/docs/tutorial/debug-tips.md b/docs/tutorial/debug-tips.md
@@ -10,7 +10,7 @@ We can run our test with [`-v/--verbose` option]. In this mode, each entry is di
 information like request HTTP headers, response HTTP headers, cookie storage, duration etc...
 
 ```shell
-$ hurl --verbose --no-ouput basic.hurl
+$ hurl --verbose --no-output basic.hurl
 [1;34m*[0m [1mOptions:[0m
 [1;34m*[0m     fail fast: true
 [1;34m*[0m     insecure: false
@@ -94,7 +94,7 @@ In verbose mode, HTTP request and response bodies are not displayed in the debug
 request or response body, you can display more logs with [`--very-verbose`] option:
 
 ```shell
-$ hurl --very-verbose --no-ouput basic.hurl
+$ hurl --very-verbose --no-output basic.hurl
 [1;34m*[0m [1mOptions:[0m
 [1;34m*[0m     fail fast: true
 [1;34m*[0m     insecure: false
@@ -246,7 +246,7 @@ HTTP/1.1 200
 And run it without [`--verbose`] option:
 
 ```shell
-$ hurl --no-ouput basic.hurl
+$ hurl --no-output basic.hurl
 [1;34m*[0m [1m------------------------------------------------------------------------------[0m
 [1;34m*[0m [1mExecuting entry 4[0m
 [1;34m*[0m

diff --git a/packages/hurl/README.md b/packages/hurl/README.md
@@ -159,8 +159,8 @@ Table of Contents
          * [Query Params](#query-params)
          * [Basic Authentication](#basic-authentication)
       * [Sending Data](#sending-data)
-         * [Sending HTML Form Datas](#sending-html-form-datas)
-         * [Sending Multipart Form Datas](#sending-multipart-form-datas)
+         * [Sending HTML Form Data](#sending-html-form-data)
+         * [Sending Multipart Form Data](#sending-multipart-form-data)
          * [Posting a JSON Body](#posting-a-json-body)
          * [Templating a JSON / XML Body](#templating-a-json--xml-body)
       * [Testing Response](#testing-response)
@@ -298,7 +298,7 @@ you could use [`-u/--user` option].
 
 ## Sending Data
 
-### Sending HTML Form Datas
+### Sending HTML Form Data
 
 ```hurl
 POST https://example.org/contact
@@ -311,7 +311,7 @@ number: 33611223344
 
 [Doc](https://hurl.dev/docs/request.html#form-parameters)
 
-### Sending Multipart Form Datas
+### Sending Multipart Form Data
 
 ```hurl
 POST https://example.org/upload
@@ -436,7 +436,7 @@ jsonpath "$.hasDevice" == false
 jsonpath "$.links" count == 12
 jsonpath "$.state" != null
 jsonpath "$.order" matches "^order-\\d{8}$"
-jsonpath "$.order" matches /^order-\d{8}$/     # Alternative syntax with regex litteral
+jsonpath "$.order" matches /^order-\d{8}$/     # Alternative syntax with regex literal
 ```
 
 [Doc](https://hurl.dev/docs/asserting-response.html#jsonpath-assert)
@@ -738,7 +738,7 @@ Option | Description
 <a href="#cookie" id="cookie"><code>-b, --cookie &lt;file&gt;</code></a> | Read cookies from file (using the Netscape cookie file format).<br/><br/>Combined with [`-c, --cookie-jar`](#cookie-jar), you can simulate a cookie storage between successive Hurl runs.<br/>
 <a href="#cookie-jar" id="cookie-jar"><code>-c, --cookie-jar &lt;file&gt;</code></a> | Write cookies to FILE after running the session (only for one session).<br/>The file will be written using the Netscape cookie file format.<br/><br/>Combined with [`-b, --cookie`](#cookie), you can simulate a cookie storage between successive Hurl runs.<br/>
 <a href="#fail-at-end" id="fail-at-end"><code>--fail-at-end</code></a> | Continue executing requests to the end of the Hurl file even when an assert error occurs.<br/>By default, Hurl exits after an assert error in the HTTP response.<br/><br/>Note that this option does not affect the behavior with multiple input Hurl files.<br/><br/>All the input files are executed independently. The result of one file does not affect the execution of the other Hurl files.<br/>
-<a href="#file-root" id="file-root"><code>--file-root &lt;dir&gt;</code></a> | Set root filesystem to import files in Hurl. This is used for both files in multipart form data and request body.<br/>When this is not explicitly defined, the files are relative to the current directory in which Hurl is running.<br/>
+<a href="#file-root" id="file-root"><code>--file-root &lt;dir&gt;</code></a> | Set root file system to import files in Hurl. This is used for both files in multipart form data and request body.<br/>When this is not explicitly defined, the files are relative to the current directory in which Hurl is running.<br/>
 <a href="#location" id="location"><code>-L, --location</code></a> | Follow redirect. To limit the amount of redirects to follow use the [`--max-redirs`](#max-redirs) option<br/>
 <a href="#glob" id="glob"><code>--glob &lt;glob&gt;</code></a> | Specify input files that match the given glob pattern.<br/><br/>Multiple glob flags may be used. This flag supports common Unix glob patterns like *, ? and []. <br/>However, to avoid your shell accidentally expanding glob patterns before Hurl handles them, you must use single quotes or double quotes around each pattern.<br/>
 <a href="#include" id="include"><code>-i, --include</code></a> | Include the HTTP headers in the output (last entry).<br/>
@@ -985,5 +985,5 @@ Please follow the [contrib on Windows section].
 [install]: https://www.rust-lang.org/tools/install
 [Rust]: https://www.rust-lang.org
 [contrib on Windows section]: https://github.com/Orange-OpenSource/hurl/blob/master/contrib/windows/README.md
-[NixOS / Nix package]: https://search.nixos.org/packages?channel=21.11&from=0&size=1&sort=relevance&type=packages&query=hurl
+[NixOS / Nix package]: https://search.nixos.org/packages?from=0&size=1&sort=relevance&type=packages&query=hurl
-Original file line number
+Diff line change
@@ Expand Up / @@ -619,7 +619,7 @@ or @@
     ~~~
-    Finaly, raw string can be used without any newline:
+    Finally, raw string can be used without any newline:
     ~~~
     ```line```
@@ Expand Down @@