Skip to content

Commit 3174bc1

Browse files
Trotttargos
authored andcommittedJul 2, 2019
doc: remove "note that" from http.md
Refs: nodejs/remark-preset-lint-node#16 PR-URL: #28329 Reviewed-By: Gus Caplan <[email protected]> Reviewed-By: Trivikram Kamat <[email protected]> Reviewed-By: Tobias Nießen <[email protected]> Reviewed-By: Ruben Bridgewater <[email protected]>
1 parent f0a857f commit 3174bc1

File tree

1 file changed

+14
-14
lines changed

1 file changed

+14
-14
lines changed
 

‎doc/api/http.md

+14-14
Original file line numberDiff line numberDiff line change
@@ -624,7 +624,7 @@ added: v1.6.0
624624
* `name` {string}
625625
* Returns: {any}
626626

627-
Reads out a header on the request. Note that the name is case insensitive.
627+
Reads out a header on the request. The name is case-insensitive.
628628
The type of the return value depends on the arguments provided to
629629
[`request.setHeader()`][].
630630

@@ -810,7 +810,7 @@ client should continue to send the request body, or generating an appropriate
810810
HTTP response (e.g. 400 Bad Request) if the client should not continue to send
811811
the request body.
812812

813-
Note that when this event is emitted and handled, the [`'request'`][] event will
813+
When this event is emitted and handled, the [`'request'`][] event will
814814
not be emitted.
815815

816816
### Event: 'checkExpectation'
@@ -825,7 +825,7 @@ Emitted each time a request with an HTTP `Expect` header is received, where the
825825
value is not `100-continue`. If this event is not listened for, the server will
826826
automatically respond with a `417 Expectation Failed` as appropriate.
827827

828-
Note that when this event is emitted and handled, the [`'request'`][] event will
828+
When this event is emitted and handled, the [`'request'`][] event will
829829
not be emitted.
830830

831831
### Event: 'clientError'
@@ -939,7 +939,7 @@ added: v0.1.0
939939
* `request` {http.IncomingMessage}
940940
* `response` {http.ServerResponse}
941941

942-
Emitted each time there is a request. Note that there may be multiple requests
942+
Emitted each time there is a request. There may be multiple requests
943943
per connection (in the case of HTTP Keep-Alive connections).
944944

945945
### Event: 'upgrade'
@@ -1118,7 +1118,7 @@ Trailers will **only** be emitted if chunked encoding is used for the
11181118
response; if it is not (e.g. if the request was HTTP/1.0), they will
11191119
be silently discarded.
11201120

1121-
Note that HTTP requires the `Trailer` header to be sent in order to
1121+
HTTP requires the `Trailer` header to be sent in order to
11221122
emit trailers, with a list of the header fields in its value. E.g.,
11231123

11241124
```js
@@ -1184,7 +1184,7 @@ added: v0.4.0
11841184
* Returns: {any}
11851185

11861186
Reads out a header that's already been queued but not sent to the client.
1187-
Note that the name is case insensitive. The type of the return value depends
1187+
The name is case-insensitive. The type of the return value depends
11881188
on the arguments provided to [`response.setHeader()`][].
11891189

11901190
```js
@@ -1252,7 +1252,7 @@ added: v7.7.0
12521252
* Returns: {boolean}
12531253

12541254
Returns `true` if the header identified by `name` is currently set in the
1255-
outgoing headers. Note that the header name matching is case-insensitive.
1255+
outgoing headers. The header name matching is case-insensitive.
12561256

12571257
```js
12581258
const hasContentType = response.hasHeader('content-type');
@@ -1435,7 +1435,7 @@ it will switch to implicit header mode and flush the implicit headers.
14351435
This sends a chunk of the response body. This method may
14361436
be called multiple times to provide successive parts of the body.
14371437

1438-
Note that in the `http` module, the response body is omitted when the
1438+
In the `http` module, the response body is omitted when the
14391439
request is a HEAD request. Similarly, the `204` and `304` responses
14401440
_must not_ include a message body.
14411441

@@ -1528,11 +1528,11 @@ const server = http.createServer((req, res) => {
15281528
});
15291529
```
15301530

1531-
Note that Content-Length is given in bytes not characters. The above example
1531+
`Content-Length` is given in bytes not characters. The above example
15321532
works because the string `'hello world'` contains only single byte characters.
15331533
If the body contains higher coded characters then `Buffer.byteLength()`
15341534
should be used to determine the number of bytes in a given encoding.
1535-
And Node.js does not check whether Content-Length and the length of the body
1535+
And Node.js does not check whether `Content-Length` and the length of the body
15361536
which has been transmitted are equal or not.
15371537

15381538
Attempting to set a header field name or value that contains invalid characters
@@ -1687,7 +1687,7 @@ added: v0.11.6
16871687

16881688
The raw request/response headers list exactly as they were received.
16891689

1690-
Note that the keys and values are in the same list. It is *not* a
1690+
The keys and values are in the same list. It is *not* a
16911691
list of tuples. So, the even-numbered offsets are key values, and the
16921692
odd-numbered offsets are the associated values.
16931693

@@ -1908,7 +1908,7 @@ changes:
19081908
Since most requests are GET requests without bodies, Node.js provides this
19091909
convenience method. The only difference between this method and
19101910
[`http.request()`][] is that it sets the method to GET and calls `req.end()`
1911-
automatically. Note that the callback must take care to consume the response
1911+
automatically. The callback must take care to consume the response
19121912
data for reasons stated in [`http.ClientRequest`][] section.
19131913

19141914
The `callback` is invoked with a single argument that is an instance of
@@ -2083,7 +2083,7 @@ req.write(postData);
20832083
req.end();
20842084
```
20852085

2086-
Note that in the example `req.end()` was called. With `http.request()` one
2086+
In the example `req.end()` was called. With `http.request()` one
20872087
must always call `req.end()` to signify the end of the request -
20882088
even if there is no data being written to the request body.
20892089

@@ -2157,7 +2157,7 @@ will be emitted in the following order:
21572157
* `'end'` on the `res` object
21582158
* `'close'` on the `res` object
21592159

2160-
Note that setting the `timeout` option or using the `setTimeout()` function will
2160+
Setting the `timeout` option or using the `setTimeout()` function will
21612161
not abort the request or do anything besides add a `'timeout'` event.
21622162

21632163
[`--http-server-default-timeout`]: cli.html#cli_http_server_default_timeout_milliseconds

0 commit comments

Comments
 (0)
Please sign in to comment.