From c62941e84c4d3e4ece141847dd5a1c94efd7de5e Mon Sep 17 00:00:00 2001 From: Rich Trott Date: Thu, 2 Jul 2020 16:36:38 -0700 Subject: [PATCH] doc: remove parenthetical \r\n comment in http and http2 docs The explanation that the HTTP requests include `\r\n` is true but not important or relevant in these two specific contexts. PR-URL: https://github.com/nodejs/node/pull/34178 Reviewed-By: James M Snell Reviewed-By: Michael Dawson --- doc/api/http.md | 3 +-- doc/api/http2.md | 5 ++--- 2 files changed, 3 insertions(+), 5 deletions(-) diff --git a/doc/api/http.md b/doc/api/http.md index 1ae77464087e2c..43b368583dc626 100644 --- a/doc/api/http.md +++ b/doc/api/http.md @@ -1983,8 +1983,7 @@ added: v0.1.90 **Only valid for request obtained from [`http.Server`][].** Request URL string. This contains only the URL that is present in the actual -HTTP request. If the request is (remember, each header line ends with `\r\n` -plus a final `\r\n` after the last one indicating the end of the header): +HTTP request. Take the following request: ```http GET /status?name=ryan HTTP/1.1 diff --git a/doc/api/http2.md b/doc/api/http2.md index 3c4c7b85a79f54..3ff984a3e25e6a 100644 --- a/doc/api/http2.md +++ b/doc/api/http2.md @@ -2988,8 +2988,7 @@ added: v8.4.0 * {string} Request URL string. This contains only the URL that is present in the actual -HTTP request. If the request is (remember, each header line ends with `\r\n` -plus a final `\r\n` after the last one indicating the end of the header): +HTTP request. If the request is: ```http GET /status?name=ryan HTTP/1.1 @@ -3003,7 +3002,7 @@ Then `request.url` will be: '/status?name=ryan' ``` -To parse the url into its parts `require('url').parse(request.url)` +To parse the url into its parts, `require('url').parse(request.url)` can be used: ```console