-
Notifications
You must be signed in to change notification settings - Fork 315
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Docs updates #290
Docs updates #290
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Well written, I could only find minor nits.
docs/source/basics.rst
Outdated
which numerical OID maps to which curve parameters. Thus the prospect of | ||
using the explicit encoding, where all the needed parameters are provided | ||
is tempting, the downside is that curve parameters may specify a *weak* | ||
curve, which is easy to attack and break (that is deduce the private key |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
"that is to deduce" maybe?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
yes
docs/source/glossary.rst
Outdated
Elliptic Curve Digital Signature Algorithm | ||
|
||
EdDSA | ||
Edward curve based Digital Signature Algorithm, the alternative |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Edward → Edwards
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
yes
docs/source/glossary.rst
Outdated
|
||
EdDSA | ||
Edward curve based Digital Signature Algorithm, the alternative | ||
digitial signature algorithm that's used for Curve25519 or Curve448 |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
digitial → digital
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
yes
docs/source/glossary.rst
Outdated
encoding of NIST256p public key will be 65 bytes long. | ||
|
||
PEM | ||
The acronym stands for Privacy Enhanced Email, but currently it is used |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Privacy Enhanced Mail?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
yes, should be "Mail"
docs/source/glossary.rst
Outdated
|
||
bytes-like object | ||
All the types that implement the buffer protocol. That includes | ||
``str`` (only on python2), ``bytes``, ``bytesarray``, ``array.array`` |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
bytesarray
→ bytearray
?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
right
@ueno Thanks, I've fixed the issues. |
Project description, badge, more updates to docs
Work towards #95
fixes #278