From: Mark Wooding <mdw@distorted.org.uk>
Date: Mon, 12 Sep 2016 21:23:38 +0000 (+0100)
Subject: *.c: Fix docstrings for methods.
X-Git-Tag: 1.1.2~8
X-Git-Url: http://www.chiark.greenend.org.uk/ucgi/~mdw/git/catacomb-python/commitdiff_plain/5ec4e0d8db70dd19d6c294092c71e608d2888bb5

*.c: Fix docstrings for methods.

Mostly fixing method names andarguments broken by bad copy-and-paste
editing.
---

diff --git a/key.c b/key.c
index 6a601c9..a3cd200 100644
--- a/key.c
+++ b/key.c
@@ -467,7 +467,7 @@ static PyMethodDef keydata_pymethods[] = {
   METH	(split,			"KD.split()")
   KWMETH(write,			"KD.write(filter = <any>) -> STRING")
   KWMETH(encode,		"KD.encode(filter = <any>) -> BYTES")
-  KWMETH(copy,			"KD.encode(filter = <any>) -> KD")
+  KWMETH(copy,			"KD.copy(filter = <any>) -> KD")
   METH	(plock,			"KD.plock(TAG) -> ENCRYPTED-KD")
   METH	(lock,			"KD.lock(KEY) -> ENCRYPTED-KD")
 #undef METHNAME
@@ -2081,7 +2081,7 @@ static PyMethodDef methods[] = {
 	   "KeyData.readflags(STRING) -> (FLAGS, MASK, REST)")
   METH	(_KeyData_writeflags,	"KeyData.writeflags(FLAGS) -> STRING")
   METH	(_KeyData_read,		"KeyData.read(STRING) -> (KD, REST)")
-  METH	(_KeyData_decode,	"KeyData.read(BYTES) -> KD")
+  METH	(_KeyData_decode,	"KeyData.decode(BYTES) -> KD")
   METH	(barf,			"barf(ERR)")
 #undef METHNAME
   { 0 }
diff --git a/mp.c b/mp.c
index 2434eaf..8f57ad1 100644
--- a/mp.c
+++ b/mp.c
@@ -1309,17 +1309,17 @@ static PyGetSetDef mpmont_pygetset[] = {
 
 static PyMethodDef mpmont_pymethods[] = {
 #define METHNAME(name) mmmeth_##name
-  METH	(int,		"M.out(X) -> XR")
+  METH	(int,		"M.int(X) -> XR")
   METH	(mul,		"M.mul(XR, YR) -> ZR where Z = X Y")
   METH	(expr,		"M.expr(XR, N) -> ZR where Z = X^N mod M.m")
   METH	(mexpr,		"\
-B.mexp([(XR0, N0), (XR1, N1), ...]) = ZR where Z = X0^N0 X1^N1 mod B.m\n\
+M.mexpr([(XR0, N0), (XR1, N1), ...]) = ZR where Z = X0^N0 X1^N1 ... mod M.m\n\
 \t(the list may be flattened if this more convenient.)")
   METH	(reduce,	"M.reduce(XR) -> X")
   METH	(ext,		"M.ext(XR) -> X")
   METH	(exp,		"M.exp(X, N) -> X^N mod M.m")
   METH	(mexp,		"\
-B.mexp([(X0, N0), (X1, N1), ...]) = X0^N0 X1^N1 mod B.m\n\
+M.mexp([(X0, N0), (X1, N1), ...]) = X0^N0 X1^N1 ... mod M.m\n\
 \t(the list may be flattened if this more convenient.)")
 #undef METHNAME
   { 0 }
@@ -1458,7 +1458,7 @@ static PyMethodDef mpbarrett_pymethods[] = {
   METH	(reduce,	"B.reduce(X) -> X mod B.m")
   METH	(exp,		"B.exp(X, N) -> X^N mod B.m")
   METH	(mexp,		"\
-B.mexp([(X0, N0), (X1, N1), ...]) = X0^N0 X1^N1 mod B.m\n\
+B.mexp([(X0, N0), (X1, N1), ...]) = X0^N0 X1^N1 ... mod B.m\n\
 \t(the list may be flattened if this more convenient.)")
 #undef METHNAME
   { 0 }
diff --git a/pgen.c b/pgen.c
index 15d1f6a..24639ec 100644
--- a/pgen.c
+++ b/pgen.c
@@ -1035,8 +1035,8 @@ pgen(START, [name = 'p', stepper = PrimeGenStepper(2),\n\
 strongprime_setup(NBITS, [name = 'p', event = pgen_nullev,\n\
 		  rng = rand, nsteps = 0]) -> (START, JUMP)")
   KWMETH(strongprime,			"\
-strongprime_setup(NBITS, [name = 'p', event = pgen_nullev,\n\
-		  rng = rand, nsteps = 0]) -> P")
+strongprime(NBITS, [name = 'p', event = pgen_nullev,\n\
+	    rng = rand, nsteps = 0]) -> P")
   KWMETH(limlee,			"\
 limlee(PBITS, QBITS, [name = 'p', event = pgen_nullev,\n\
        ievent = pgen_nullev, rng = rand, nsteps = 0]) -> (P, [Q, ...])")
diff --git a/rand.c b/rand.c
index 49aaa38..6e1d05e 100644
--- a/rand.c
+++ b/rand.c
@@ -256,7 +256,7 @@ static PyMethodDef grand_pymethods[] = {
   METH	(byte,		"R.byte() -> BYTE")
   METH	(word,		"R.word() -> WORD")
   METH	(block,		"R.block(N) -> STRING")
-  KWMETH(mp,		"R.mp(bits, or = 0) -> MP")
+  KWMETH(mp,		"R.mp(bits, [or = 0]) -> MP")
   METH	(range,		"R.range(MAX) -> INT")
   METH	(mask,		"R.mask(STR) -> STR")
   METH	(seedint,	"R.seedint(I)")