[tor-commits] [tor/master] rust/protover: fix docs for UnvalidatedProtoEntry::from_str

nickm at torproject.org nickm at torproject.org
Fri Aug 17 13:07:20 UTC 2018


commit fc7fed6155ab62b1347682c0b1539a5ac292bbee
Author: cypherpunks <cypherpunks at torproject.org>
Date:   Tue Aug 7 15:06:18 2018 +0000

    rust/protover: fix docs for UnvalidatedProtoEntry::from_str
    
    This got shuffled around in b786b146edd33b025774819f54d7bba3d07bf832
    and hasn't been accurate since 124caf28e6db1e7bf8cdfef25c55760c81fb91b5.
---
 src/rust/protover/protover.rs | 6 ++----
 1 file changed, 2 insertions(+), 4 deletions(-)

diff --git a/src/rust/protover/protover.rs b/src/rust/protover/protover.rs
index f8e64c822..157027750 100644
--- a/src/rust/protover/protover.rs
+++ b/src/rust/protover/protover.rs
@@ -493,11 +493,9 @@ impl FromStr for UnvalidatedProtoEntry {
     ///
     /// # Returns
     ///
-    /// A `Result` whose `Ok` value is a `ProtoSet` holding all of the
-    /// unique version numbers.
+    /// A `Result` whose `Ok` value is an `UnvalidatedProtoEntry`.
     ///
-    /// The returned `Result`'s `Err` value is an `ProtoverError` whose `Display`
-    /// impl has a description of the error.
+    /// The returned `Result`'s `Err` value is an `ProtoverError`.
     ///
     /// # Errors
     ///





More information about the tor-commits mailing list