From e7a05f98925dcd8461845b67fa5769b24aa88961 Mon Sep 17 00:00:00 2001
From: Daze <dazehere@yandex.com>
Date: Tue, 1 Mar 2022 05:47:08 +0545
Subject: [PATCH] fix(docs): TestRequest example fixed (#2643)
Co-authored-by: Rob Ede <robjtede@icloud.com>
---
actix-web/src/test/test_request.rs | 16 +++++++++-------
1 file changed, 9 insertions(+), 7 deletions(-)
diff --git a/actix-web/src/test/test_request.rs b/actix-web/src/test/test_request.rs
index fc42253d..a368d873 100644
--- a/actix-web/src/test/test_request.rs
+++ b/actix-web/src/test/test_request.rs
@@ -24,10 +24,10 @@ use crate::cookie::{Cookie, CookieJar};
///
/// For unit testing, actix provides a request builder type and a simple handler runner. TestRequest implements a builder-like pattern.
/// You can generate various types of request via TestRequest's methods:
-/// * `TestRequest::to_request` creates `actix_http::Request` instance.
-/// * `TestRequest::to_srv_request` creates `ServiceRequest` instance, which is used for testing middlewares and chain adapters.
-/// * `TestRequest::to_srv_response` creates `ServiceResponse` instance.
-/// * `TestRequest::to_http_request` creates `HttpRequest` instance, which is used for testing handlers.
+/// - [`TestRequest::to_request`] creates an [`actix_http::Request`](Request).
+/// - [`TestRequest::to_srv_request`] creates a [`ServiceRequest`], which is used for testing middlewares and chain adapters.
+/// - [`TestRequest::to_srv_response`] creates a [`ServiceResponse`].
+/// - [`TestRequest::to_http_request`] creates an [`HttpRequest`], which is used for testing handlers.
///
/// ```
/// use actix_web::{test, HttpRequest, HttpResponse, HttpMessage};
@@ -42,15 +42,17 @@ use crate::cookie::{Cookie, CookieJar};
/// }
///
/// #[actix_web::test]
+/// # // force rustdoc to display the correct thing and also compile check the test
+/// # async fn _test() {}
/// async fn test_index() {
-/// let req = test::TestRequest::default().insert_header("content-type", "text/plain")
+/// let req = test::TestRequest::default().insert_header(header::ContentType::plaintext())
/// .to_http_request();
///
-/// let resp = index(req).await.unwrap();
+/// let resp = index(req).await;
/// assert_eq!(resp.status(), StatusCode::OK);
///
/// let req = test::TestRequest::default().to_http_request();
-/// let resp = index(req).await.unwrap();
+/// let resp = index(req).await;
/// assert_eq!(resp.status(), StatusCode::BAD_REQUEST);
/// }
/// ```