Skip to content

Commit f55691a

Browse files
authored
updated docs (#11)
* updated docs * makefile should build new wheel when building docs
1 parent 5a0c5bf commit f55691a

File tree

3 files changed

+8
-8
lines changed

3 files changed

+8
-8
lines changed

Makefile

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ test:
1212
cargo test --no-default-features
1313
pytest -n auto
1414

15-
docs:
15+
docs: develop
1616
pdoc jam_vrf -o docs
1717

1818
format:

docs/jam_vrf.html

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -126,17 +126,16 @@ <h1 class="modulename">
126126

127127
<div class="docstring"><p>Verify a batch of ring signatures</p>
128128

129-
<p><strong>Args:</strong>
130-
-</p>
129+
<p><strong>Args:</strong></p>
131130

132131
<ul>
133-
<li>batch: [(data, additional data, signature)] - collection of data &amp; signatures to be verified. All of the tuple fields are python bytes type.</li>
132+
<li>batch: [(data, additional_data, signature)] - collection of data &amp; signatures to be verified. All of the tuple fields are python bytes type.</li>
134133
</ul>
135134

136135
<p><strong>Raises:</strong></p>
137136

138137
<ul>
139-
<li><code>ValueError(Dict{index: PyErr})</code> - a dictionary mapping invalid indexes to validation errors</li>
138+
<li><code>ValueError(Dict{index: PyErr})</code> - contains a dictionary mapping invalid indexes to validation errors</li>
140139
<li><code>Exception</code> - internal error</li>
141140
</ul>
142141

@@ -146,8 +145,9 @@ <h1 class="modulename">
146145

147146
try:
148147
verifier.verify([data, ad, signature], [data, ad, signature])
149-
except ValueError:
150-
print("batch contains an invalid signature!")
148+
except ValueError as e:
149+
for batch_index, error in e.args[0].items():
150+
print("batch index {} produced error: {}".format(batch_index, error))
151151
</code></pre>
152152
</div>
153153

docs/search.js

Lines changed: 1 addition & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

0 commit comments

Comments
 (0)