*.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 6a601c951ea15b1ad3e24edab992fd2ca213bcda..a3cd200b1189a4f9f05aec1e98b702468c898b67 100644 (file)
--- 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")
   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
   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)")
           "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 }
   METH (barf,                  "barf(ERR)")
 #undef METHNAME
   { 0 }

diff --git a/mp.c b/mp.c
index 2434eaf75f1147e54cfb25be55ac5a05066075d7..8f57ad12ec251dc8e56b848077d354687bfe6e6f 100644 (file)
--- a/mp.c
+++ b/mp.c
@@ -1309,17 +1309,17 @@ static PyGetSetDef mpmont_pygetset[] = {
 
 static PyMethodDef mpmont_pymethods[] = {
 #define METHNAME(name) mmmeth_##name
 
 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,         "\
   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,          "\
 \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 }
 \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,          "\
   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 }
 \t(the list may be flattened if this more convenient.)")
 #undef METHNAME
   { 0 }

diff --git a/pgen.c b/pgen.c
index 15d1f6a0ebb33acca387f730c8d6ea3049bc255e..24639ecff96dfa95c11b4e729597b1717522a9c8 100644 (file)
--- 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]) -> (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, ...])")
   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 49aaa38f933f2db0c2aeae45f2c84a1afacd67ad..6e1d05efcb4ae5edd6822cac0f74cbc5f2751f33 100644 (file)
--- 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")
   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)")
   METH (range,         "R.range(MAX) -> INT")
   METH (mask,          "R.mask(STR) -> STR")
   METH (seedint,       "R.seedint(I)")