minor doc cleanups

Author: 0trust3r

docs/jam_vrf.html

@@ -89,7 +89,7 @@ <h1 class="modulename">
     </div>
     <a class="headerlink" href="#RingVerifier"></a>
 
-            <div class="docstring"><p>Used for verifying signatures against a particular ring</p>
+            <div class="docstring"><p>Used for verifying ring signatures</p>
 
 <p><strong>Constructor Args:</strong></p>
 
@@ -108,7 +108,7 @@ <h1 class="modulename">
 
 <pre><code>try:
     verifier = RingVerifier(commitment, ring_size)
-except Exception as e:
+except Exception:
     ...
 </code></pre>
 </div>
@@ -147,7 +147,7 @@ <h1 class="modulename">
 
 try:
     verifier.verify(data, ad, signature)
-except ValueError as e:
+except ValueError :
     print("invalid signature!")
 </code></pre>
 </div>
@@ -165,7 +165,7 @@ <h1 class="modulename">
     </div>
     <a class="headerlink" href="#VRFOutput"></a>
 
-            <div class="docstring"><p>VRF output type common to both ietf and ring VRFs</p>
+            <div class="docstring"><p>VRF output type common to both IETF and ring VRFs</p>
 
 <p><strong>Args:</strong></p>
 
@@ -193,9 +193,9 @@ <h1 class="modulename">
     </div>
     <a class="headerlink" href="#VRFOutput.hash"></a>
 
-            <div class="docstring"><p>Hash the VRF output point</p>
+            <div class="docstring"><p>Hash the output point</p>
 
-<p><strong>Example:</strong> <code>id = VRFOutput(...).hash()</code></p>
+<p><strong>Example:</strong> <code>h = VRFOutput(...).hash()</code></p>
 </div>
 
 
@@ -236,7 +236,7 @@ <h1 class="modulename">
 
 <pre><code>try:
     commitment = get_ring_commitment(public_keys)
-except Exception as e:
+except Exception:
     ...
 </code></pre>
 </div>
@@ -258,7 +258,7 @@ <h1 class="modulename">
 <p><strong>Args:</strong></p>
 
 <ul>
-<li>public_keys: <code>bytes</code> - bandersnatch public key</li>
+<li>public_key: <code>bytes</code> - bandersnatch public key</li>
 <li>data: <code>bytes</code></li>
 <li>ad: <code>bytes</code> - additional data</li>
 <li>signature: <code>bytes</code></li>
@@ -275,7 +275,7 @@ <h1 class="modulename">
 
 <pre><code>try:
     ietf_verify(public_key, data, ad, signature)
-except ValueError as e:
+except ValueError :
     print("invalid signature!")
 </code></pre>
 </div>

docs/search.js

@@ -9,7 +9,7 @@ use pyo3::prelude::*;
 /// Verify an IETF signature against some data & additional data
 ///
 /// **Args:**
-/// - public_keys: `bytes` - bandersnatch public key
+/// - public_key: `bytes` - bandersnatch public key
 /// - data: `bytes`
 /// - ad: `bytes` - additional data
 /// - signature: `bytes`
@@ -22,7 +22,7 @@ use pyo3::prelude::*;
 /**```
 try:
     ietf_verify(public_key, data, ad, signature)
-except ValueError as e:
+except ValueError :
     print("invalid signature!")
 ```*/
 #[pyfunction]

src/ietf.rs

@@ -46,7 +46,7 @@ fn get_pcs_params() -> PcsParams {
 /**```
 try:
     commitment = get_ring_commitment(public_keys)
-except Exception as e:
+except Exception:
     ...
 ```*/
 #[pyfunction]
@@ -83,7 +83,7 @@ pub fn get_ring_commitment(py: Python<'_>, public_keys: Vec<Vec<u8>>) -> PyResul
     Ok(PyBytes::new(py, &bytes).into())
 }
 
-/// Used for verifying signatures against a particular ring
+/// Used for verifying ring signatures
 ///
 /// **Constructor Args:**
 /// - commitment: `bytes` - ring commitment (in JAM this is called a **ring root**)
@@ -96,7 +96,7 @@ pub fn get_ring_commitment(py: Python<'_>, public_keys: Vec<Vec<u8>>) -> PyResul
 /**```
 try:
     verifier = RingVerifier(commitment, ring_size)
-except Exception as e:
+except Exception:
     ...
 ```*/
 #[pyclass]
@@ -141,7 +141,7 @@ impl RingVerifier {
 
     try:
         verifier.verify(data, ad, signature)
-    except ValueError as e:
+    except ValueError :
         print("invalid signature!")
     */
     fn verify(&self, data: &[u8], ad: &[u8], signature: &[u8]) -> PyResult<()> {

src/ring.rs

@@ -5,7 +5,7 @@ use bandersnatch::{AffinePoint, Output};
 use pyo3::prelude::*;
 use pyo3::types::PyBytes;
 
-/// VRF output type common to both ietf and ring VRFs
+/// VRF output type common to both IETF and ring VRFs
 ///
 /// **Args:**
 /// - output: `bytes`
@@ -26,9 +26,9 @@ impl VRFOutput {
         Ok(Self(Output::from(affine)))
     }
 
-    /// Hash the VRF output point
+    /// Hash the output point
     ///
-    /// **Example:** `id = VRFOutput(...).hash()`
+    /// **Example:** `h = VRFOutput(...).hash()`
     fn hash<'py>(&self, py: Python<'py>) -> Py<PyBytes> {
         PyBytes::new(py, &self.0.hash()).into()
     }