From 3a501ff77431d6f73bfd60c62418bdca7a4359cb Mon Sep 17 00:00:00 2001 From: Marcin Mielniczuk Date: Thu, 5 Oct 2017 21:57:28 +0200 Subject: [PATCH] Document cookie status --- src/lib.rs | 8 +++++++- 1 file changed, 7 insertions(+), 1 deletion(-) diff --git a/src/lib.rs b/src/lib.rs index 84cebe2..6ac21cc 100644 --- a/src/lib.rs +++ b/src/lib.rs @@ -14,7 +14,12 @@ //! - Plain bodies, JSON, urlencoded, multipart //! - Customizable redirect policy //! - Proxies -//! - (TODO: Cookies) +//! - Cookies (only rudimentary support, full support is TODO) +//! +//! The rudimentary cookie support means that the cookies need to be manually +//! configured for every single request. In other words, there's no cookie jar +//! support as of now. The tracking issue for this feature is available +//! [on GitHub][cookiejar_issue]. //! //! The `reqwest::Client` is synchronous, making it a great fit for //! applications that only require a few HTTP requests, and wish to handle @@ -118,6 +123,7 @@ //! [get]: ./fn.get.html //! [builder]: ./struct.RequestBuilder.html //! [serde]: http://serde.rs +//! [cookiejar_issue]: https://github.com/seanmonstar/reqwest/issues/14 extern crate bytes; #[macro_use]