*.c: Consistently show keyword arguments as optional in docstrings.

[catacomb-python] / mp.c

diff --git a/mp.c b/mp.c
index 2aa4cabb0d724ad61cc9ee387165bd61d75aa69c..a234c6d27c483727e14a99b123215e9299b909c7 100644 (file)
--- a/mp.c
+++ b/mp.c
@@ -809,14 +809,14 @@ static PyMethodDef mp_pymethods[] = {
   METH (modsqrt,       "X.modsqrt(Y) -> square root of Y mod X, if X prime")
   METH (leastcongruent,
         "X.leastcongruent(B, M) -> smallest Z >= B with Z == X (mod M)")
   METH (modsqrt,       "X.modsqrt(Y) -> square root of Y mod X, if X prime")
   METH (leastcongruent,
         "X.leastcongruent(B, M) -> smallest Z >= B with Z == X (mod M)")

-  KWMETH(primep,       "X.primep(rng = rand) -> true/false if X is prime")
-  KWMETH(tostring,     "X.tostring(radix = 10) -> STR")
-  KWMETH(storel,       "X.storel(len = -1) -> little-endian bytes")
-  KWMETH(storeb,       "X.storeb(len = -1) -> big-endian bytes")
+  KWMETH(primep,       "X.primep([rng = rand]) -> true/false if X is prime")
+  KWMETH(tostring,     "X.tostring([radix = 10]) -> STR")
+  KWMETH(storel,       "X.storel([len = -1]) -> little-endian bytes")
+  KWMETH(storeb,       "X.storeb([len = -1]) -> big-endian bytes")

   KWMETH(storel2c,
   KWMETH(storel2c,

-        "X.storel2c(len = -1) -> little-endian bytes, two's complement")
+        "X.storel2c([len = -1]) -> little-endian bytes, two's complement")

   KWMETH(storeb2c,
   KWMETH(storeb2c,

-        "X.storeb2c(len = -1) -> big-endian bytes, two's complement")
+        "X.storeb2c([len = -1]) -> big-endian bytes, two's complement")

   METH (tobuf,         "X.tobuf() -> buffer format")
 #undef METHNAME
   { 0 }
   METH (tobuf,         "X.tobuf() -> buffer format")
 #undef METHNAME
   { 0 }


@@ -896,7 +896,7 @@ versatile.  Support all the standard arithmetic operations, with\n\
 implicit conversions from `PrimeFilter', and other objects which\n\
 convert to `long'.\n\
 \n\
 implicit conversions from `PrimeFilter', and other objects which\n\
 convert to `long'.\n\
 \n\

-Constructor MP(X, radix = R) attempts to convert X to an `MP'.  If\n\
+Constructor MP(X, [radix = R]) attempts to convert X to an `MP'.  If\n\

 X is a string, it's read in radix-R form, or we look for a prefix\n\
 if R = 0.  Other acceptable things are field elements, elliptic curve\n\
 points, group elements, Python `int' and `long' objects, and anything\n\
 X is a string, it's read in radix-R form, or we look for a prefix\n\
 if R = 0.  Other acceptable things are field elements, elliptic curve\n\
 points, group elements, Python `int' and `long' objects, and anything\n\


@@ -2003,13 +2003,13 @@ static PyMethodDef gf_pymethods[] = {
   METH (irreduciblep,  "X.irreduciblep() -> true/false")
 #undef METHNAME
 #define METHNAME(func) mpmeth_##func
   METH (irreduciblep,  "X.irreduciblep() -> true/false")
 #undef METHNAME
 #define METHNAME(func) mpmeth_##func

-  KWMETH(tostring,     "X.tostring(radix = 10) -> STR")
-  KWMETH(storel,       "X.storel(len = -1) -> little-endian bytes")
-  KWMETH(storeb,       "X.storeb(len = -1) -> big-endian bytes")
+  KWMETH(tostring,     "X.tostring([radix = 10]) -> STR")
+  KWMETH(storel,       "X.storel([len = -1]) -> little-endian bytes")
+  KWMETH(storeb,       "X.storeb([len = -1]) -> big-endian bytes")

   KWMETH(storel2c,
   KWMETH(storel2c,

-        "X.storel2c(len = -1) -> little-endian bytes, two's complement")
+        "X.storel2c([len = -1]) -> little-endian bytes, two's complement")

   KWMETH(storeb2c,
   KWMETH(storeb2c,

-        "X.storeb2c(len = -1) -> big-endian bytes, two's complement")
+        "X.storeb2c([len = -1]) -> big-endian bytes, two's complement")

   METH (tobuf,         "X.tobuf() -> buffer format")
 #undef METHNAME
   { 0 }
   METH (tobuf,         "X.tobuf() -> buffer format")
 #undef METHNAME
   { 0 }


@@ -2087,7 +2087,7 @@ static PyTypeObject gf_pytype_skel = {
 "Binary polynomials.  Support almost all the standard arithmetic\n\
 operations.\n\
 \n\
 "Binary polynomials.  Support almost all the standard arithmetic\n\
 operations.\n\
 \n\

-Constructor GF(X, radix = R) attempts to convert X to a `GF'.  If\n\
+Constructor GF(X, [radix = R]) attempts to convert X to a `GF'.  If\n\

 X is a string, it's read in radix-R form, or we look for a prefix\n\
 if R = 0.  Other acceptable things are field elements, elliptic curve\n\
 points, group elements, Python `int' and `long' objects, and anything\n\
 X is a string, it's read in radix-R form, or we look for a prefix\n\
 if R = 0.  Other acceptable things are field elements, elliptic curve\n\
 points, group elements, Python `int' and `long' objects, and anything\n\


@@ -2472,13 +2472,13 @@ and normal basis representations.",
 static PyMethodDef methods[] = {
 #define METHNAME(func) meth_##func
   KWMETH(_MP_fromstring,       "\
 static PyMethodDef methods[] = {
 #define METHNAME(func) meth_##func
   KWMETH(_MP_fromstring,       "\

-fromstring(STR, radix = 0) -> (X, REST)\n\
+fromstring(STR, [radix = 0]) -> (X, REST)\n\

 \n\
 Parse STR as a large integer, according to radix.  If radix is zero,\n\
 read a prefix from STR to decide radix: allow `0' for octal, `0x' for hex\n\
 or `R_' for other radix R.")
   KWMETH(_GF_fromstring,       "\
 \n\
 Parse STR as a large integer, according to radix.  If radix is zero,\n\
 read a prefix from STR to decide radix: allow `0' for octal, `0x' for hex\n\
 or `R_' for other radix R.")
   KWMETH(_GF_fromstring,       "\

-fromstring(STR, radix = 0) -> (X, REST)\n\
+fromstring(STR, [radix = 0]) -> (X, REST)\n\

 \n\
 Parse STR as a binary polynomial, according to radix.  If radix is zero,\n\
 read a prefix from STR to decide radix: allow `0' for octal, `0x' for hex\n\
 \n\
 Parse STR as a binary polynomial, according to radix.  If radix is zero,\n\
 read a prefix from STR to decide radix: allow `0' for octal, `0x' for hex\n\