Corrected documentation on runtime client.

Author: David Barsky

lambda-runtime-client/src/client.rs

@@ -107,8 +107,7 @@ pub struct EventContext {
     pub identity: Option<CognitoIdentity>,
 }
 
-/// The client SDK for Lambda's Runtime APIs that implements the `RuntimeClient` trait.
-/// This object is used by the `RustRuntime` to communicate with the internal endpoint.
+/// Used by the Runtime to communicate with the internal endpoint.
 pub struct RuntimeClient {
     _runtime: Runtime,
     http_client: Client<HttpConnector, Body>,
@@ -117,15 +116,7 @@ pub struct RuntimeClient {
 
 impl RuntimeClient {
     /// Creates a new instance of the Runtime APIclient SDK. The http client has timeouts disabled and
-    /// always send the `Connection: keep-alive` header.
-    ///
-    /// # Arguments
-    ///
-    /// * `http_endpoint` The http endpoint for the Runtime APIs. This value comes from the AWS_LAMBDA_RUNTIME_API
-    ///                   environment variable.
-    ///
-    /// # Return
-    /// An instance of the Runtime APIs client SDK.
+    /// will always send a `Connection: keep-alive` header.
     pub fn new(endpoint: String, runtime: Option<Runtime>) -> Result<Self, ApiError> {
         debug!("Starting new HttpRuntimeClient for {}", endpoint);
         // start a tokio core main event loop for hyper
@@ -145,10 +136,7 @@ impl RuntimeClient {
 }
 
 impl RuntimeClient {
-    /// Makes the HTTP call to poll for new events to the Runtime APIs.
-    ///
-    /// # Return
-    /// A `Result` containing a tuple of the new event of type `E` and its `EventContext`.
+    /// Polls for new events to the Runtime APIs.
     pub fn next_event(&self) -> Result<(Vec<u8>, EventContext), ApiError> {
         let uri = format!(
             "http://{}/{}/runtime/invocation/next",

lambda-runtime-client/src/lib.rs

@@ -1,9 +1,7 @@
 #![warn(missing_docs)]
 //! Rust client SDK for the AWS Lambda Runtime APIs. This crate defines
-//! both a `RuntimeClient` trait and it's implementation: `HttpRuntimeClient`.
-//! The `HttpRuntimeClient` object exposes all of the methods available in
-//! AWS Lambda's Runtime APIs and it can be used to build any rust-related
-//! custom runtime in Lambda.
+//! a `RuntimeClient` that encapsulates interactions with AWS Lambda's Runtime
+//! APIs.
 //!
 //! To return errors to the Runtime APIs through the `event_error()` or
 //! `fail_init()` methods the `Error` objects must implement the `error::RuntimeApiError`
@@ -33,7 +31,7 @@
 //!
 //! fn main() {
 //!     let runtime_endpoint = String::from("http://localhost:8080");
-//!     let client: &RuntimeClient = &HttpRuntimeClient::new(runtime_endpoint, None)
+//!     let client = RuntimeClient::new(runtime_endpoint, None)
 //!         .expect("Could not initialize client");
 //!
 //!     let (event_data, event_context) = client.next_event()