doc: Added an info about the protocol version to to_auth

getsentry · Mar 25, 2018 · c9d357a · c9d357a
1 parent 437023c
commit c9d357a
Showing 1 changed file with 3 additions and 0 deletions.
diff --git a/src/dsn.rs b/src/dsn.rs
@@ -73,6 +73,9 @@ pub struct Dsn {
 
 impl Dsn {
     /// Converts the dsn into an auth object.
+    ///
+    /// This always attaches the latest and greatest protocol
+    /// version to the auth header.
     pub fn to_auth(&self, client_agent: Option<&str>) -> Auth {
         auth_from_dsn_and_client(self, client_agent)
     }