Provide documentation for VerifyingKey and SigningKey#117
Conversation
tomato42
added
the
maintenance
tomato42
force-pushed
the
docs
branch
4 times, most recently
from
e692521 to
76cc440
Compare
|
@ansasaki please review |
ansasaki
left a comment
ansasaki
left a comment
There was a problem hiding this comment.
I left some comments, not all of them are requests for changes, but requests for clarification.
Overall the proposed documentation is well written and concise.
|
thanks for review; will fix the issues I haven't commented on |
|
@ansasaki updated, please re-check |
| """ | ||
| Encode the signature to raw format (:term:`raw encoding`) | ||
|
|
||
| :param int r: first parametr of the signature |
|
|
||
| :param int r: first parametr of the signature | ||
| :param int s: second parameter of the signature | ||
| :param int order: the order of curve over which the signature was computed |
There was a problem hiding this comment.
s/the order of curve/the order of the curve/
| It's expected that this function will be used as a `sigencode=` parameter | ||
| in SigningKey.sign() method. | ||
|
|
||
| :param int r: first parametr of the signature |
|
|
||
| :param int r: first parametr of the signature | ||
| :param int s: second parameter of the signature | ||
| :param int order: the order of curve over which the signature was computed |
There was a problem hiding this comment.
s/the order of curve/the order of the curve/
@ansasaki good catch, can you verify? |
|
(I've also "sphinxified" the cross-links and made them a bit more consistent) |
| Abstract Syntax Notation 1 is a standard description language for | ||
| specifying serialisation and deserialisation of data structures in a | ||
| portable and cross-platform way. | ||
| """ |
There was a problem hiding this comment.
Just a nit, the glossary could be alphabetically sorted.
There was a problem hiding this comment.
it will be once it is processed by sphinx :)
| # raw encoding of point is invalid in DER files | ||
| if not point_str.startswith(b("\x00")) or \ | ||
| len(point_str[1:]) == curve.verifying_key_length: | ||
| # the bitsting encoding is padded with a zero byte |
There was a problem hiding this comment.
heh, that was actually fixed by the new code that fixed behaviour of bitstring so the rebase fixed it
also do minor cleanup with initialisers and imports
use canonical name for first parameter in classmethods minor fixes with formatting
|
Thank you! |
3 participants
Document the VerifyingKey, SigningKey and few directly related classes.
fixes #56
work towards #95