From 51751ee26c1123ed5f6b442c6ca9dbb5f759c465 Mon Sep 17 00:00:00 2001 From: Nik <njunger@uwaterloo.ca> Date: Sat, 14 Feb 2015 16:47:09 -0500 Subject: [PATCH] Documentation fixes --- INSTALL | 2 +- doc.go | 2 +- element.go | 6 +++--- generation.go | 2 +- 4 files changed, 6 insertions(+), 6 deletions(-) diff --git a/INSTALL b/INSTALL index 50ced3e..f2a1b88 100644 --- a/INSTALL +++ b/INSTALL @@ -11,7 +11,7 @@ Most systems include a package for GMP. To install GMP in Debian / Ubuntu: For an RPM installation with YUM: - sudo yum install gmp + sudo yum install gmp-devel For installation with Fink (http://www.finkproject.org/) on Mac OS X: diff --git a/doc.go b/doc.go index c61311e..d225d43 100644 --- a/doc.go +++ b/doc.go @@ -78,7 +78,7 @@ For an RPM installation with YUM: - sudo yum install gmp + sudo yum install gmp-devel For installation with Fink (http://www.finkproject.org/) on Mac OS X: diff --git a/element.go b/element.go index 7a1a0c7..2e1e085 100644 --- a/element.go +++ b/element.go @@ -85,9 +85,9 @@ import "runtime" // or unchecked. Unchecked elements do not perform any sanity checks; calls are // passed directly to the C library, with the possible consequences mentioned // above. Checked elements attempt to catch a variety of errors, such as when -// elements from mismatched algebraic structures or pairings. If an error is -// detected, the operation will panic with ErrIllegalOp, ErrUncheckedOp, -// ErrIncompatible, or a similar error. +// invalid operations are performed on elements from mismatched algebraic +// structures or pairings. If an error is detected, the operation will panic +// with ErrIllegalOp, ErrUncheckedOp, ErrIncompatible, or a similar error. // // The decision on whether or not to check operations is based solely on // whether or not the target element is checked. Thus, if an unchecked element diff --git a/generation.go b/generation.go index e78e288..bb9ce57 100644 --- a/generation.go +++ b/generation.go @@ -99,7 +99,7 @@ func GenerateA1(r *big.Int) *Params { // of D, no suitable curves can be found. In this case, GenerateD returns nil // and ErrNoSuitableCurves. // -// The rbits and qbits parameters sit minimum sizes for group orders. To be +// The rbits and qbits parameters set minimum sizes for group orders. To be // secure, generic discrete log algorithms must be infeasible in groups of order // r, and finite field discrete log algorithms must be infeasible in groups of // order q^6. -- GitLab