From e4382e4fc126a495baca0e583fd95d7aaee10c0a Mon Sep 17 00:00:00 2001 From: Sameer Dhar Date: Sun, 8 Dec 2019 23:02:43 -0500 Subject: [PATCH] Fix broken docs (#1204) Fixed un escaped brackets in lib.rs, and reflowed links to ConnectionInfo in app, config, and server.rs --- actix-http/src/ws/proto.rs | 2 +- src/app.rs | 6 +++--- src/config.rs | 6 +++--- src/server.rs | 8 +++++--- 4 files changed, 12 insertions(+), 10 deletions(-) diff --git a/actix-http/src/ws/proto.rs b/actix-http/src/ws/proto.rs index df928cdbb..ad42b7a6b 100644 --- a/actix-http/src/ws/proto.rs +++ b/actix-http/src/ws/proto.rs @@ -95,7 +95,7 @@ pub enum CloseCode { Abnormal, /// Indicates that an endpoint is terminating the connection /// because it has received data within a message that was not - /// consistent with the type of the message (e.g., non-UTF-8 [RFC3629] + /// consistent with the type of the message (e.g., non-UTF-8 \[RFC3629\] /// data within a text message). Invalid, /// Indicates that an endpoint is terminating the connection diff --git a/src/app.rs b/src/app.rs index ce4f1f013..e0f56a1ac 100644 --- a/src/app.rs +++ b/src/app.rs @@ -227,9 +227,9 @@ where /// Set server host name. /// - /// Host name is used by application router as a hostname for url - /// generation. Check [ConnectionInfo](./dev/struct.ConnectionInfo. - /// html#method.host) documentation for more information. + /// Host name is used by application router as a hostname for url generation. + /// Check [ConnectionInfo](./dev/struct.ConnectionInfo.html#method.host) + /// documentation for more information. /// /// By default host name is set to a "localhost" value. pub fn hostname(mut self, val: &str) -> Self { diff --git a/src/config.rs b/src/config.rs index 57ba10079..d57791e1a 100644 --- a/src/config.rs +++ b/src/config.rs @@ -133,9 +133,9 @@ impl AppConfig { /// Set server host name. /// - /// Host name is used by application router as a hostname for url - /// generation. Check [ConnectionInfo](./dev/struct.ConnectionInfo. - /// html#method.host) documentation for more information. + /// Host name is used by application router as a hostname for url generation. + /// Check [ConnectionInfo](./struct.ConnectionInfo.html#method.host) + /// documentation for more information. /// /// By default host name is set to a "localhost" value. pub fn host(&self) -> &str { diff --git a/src/server.rs b/src/server.rs index a4569ce3d..8ee94420e 100644 --- a/src/server.rs +++ b/src/server.rs @@ -180,9 +180,11 @@ where /// Set server host name. /// - /// Host name is used by application router as a hostname for url - /// generation. Check [ConnectionInfo](./dev/struct.ConnectionInfo. - /// html#method.host) documentation for more information. + /// Host name is used by application router as a hostname for url generation. + /// Check [ConnectionInfo](./dev/struct.ConnectionInfo.html#method.host) + /// documentation for more information. + /// + /// By default host name is set to a "localhost" value. pub fn server_hostname>(mut self, val: T) -> Self { self.host = Some(val.as_ref().to_owned()); self