*.c: Reformat docstrings.

[catacomb-python] / group.c

diff --git a/group.c b/group.c
index 5d7c34bac73f44ed6944c9dfc4d564322aac1dff..3a4b05bbf4d5de6a388c6648a72c49d0730ec600 100644 (file)
--- a/group.c
+++ b/group.c
@@ -297,24 +297,24 @@ static PyObject *meth__BinDHInfo_parse(PyObject *me, PyObject *arg)
 
 static PyGetSetDef fginfo_pygetset[] = {
 #define GETSETNAME(op, name) fi##op##_##name
-  GET  (r,                     "I.r -> group order")
+  GET  (r,             "I.r -> group order")
 #undef GETSETNAME
   { 0 }
 };
 
 static PyGetSetDef dhinfo_pygetset[] = {
 #define GETSETNAME(op, name) di##op##_##name
-  GET  (p,                     "I.p -> prime")
-  GET  (g,                     "I.g -> generator")
+  GET  (p,             "I.p -> prime")
+  GET  (g,             "I.g -> generator")
 #undef GETSETNAME
   { 0 }
 };
 
 static PyGetSetDef bindhinfo_pygetset[] = {
 #define GETSETNAME(op, name) bi##op##_##name
-  GET  (p,                     "I.p -> irreducible polynomial")
-  GET  (m,                     "I.m -> degree of polynomial")
-  GET  (g,                     "I.g -> generator")
+  GET  (p,             "I.p -> irreducible polynomial")
+  GET  (m,             "I.m -> degree of polynomial")
+  GET  (g,             "I.g -> generator")
 #undef GETSETNAME
   { 0 }
 };
@@ -344,7 +344,7 @@ static PyTypeObject fginfo_pytype_skel = {
     Py_TPFLAGS_BASETYPE,
 
   /* @tp_doc@ */
-"Abstract base class for field-group information objects.",
+  "Abstract base class for field-group information objects.",
 
   0,                                   /* @tp_traverse@ */
   0,                                   /* @tp_clear@ */
@@ -392,7 +392,7 @@ static PyTypeObject dhinfo_pytype_skel = {
     Py_TPFLAGS_BASETYPE,
 
   /* @tp_doc@ */
-"DHInfo(P, R, G): standard (integer) Diffie-Hellman group information.",
+  "DHInfo(P, R, G): standard (integer) Diffie-Hellman group information.",
 
   0,                                   /* @tp_traverse@ */
   0,                                   /* @tp_clear@ */
@@ -440,7 +440,7 @@ static PyTypeObject bindhinfo_pytype_skel = {
     Py_TPFLAGS_BASETYPE,
 
   /* @tp_doc@ */
-"BinDHInfo(P, R, G): binary-field Diffie-Hellman group information.",
+  "BinDHInfo(P, R, G): binary-field Diffie-Hellman group information.",
 
   0,                                   /* @tp_traverse@ */
   0,                                   /* @tp_clear@ */
@@ -982,8 +982,8 @@ static PyMethodDef ge_pymethods[] = {
   METH (sqr,           "X.sqr() -> X^2 = X * X")
   METH (check,         "X.check() -> check X really belongs to its group")
   METH (toint,         "X.toint() -> X converted to an integer")
-  KWMETH(toec,         "\
-X.toec([curve = ECPt]) -> X converted to elliptic curve point")
+  KWMETH(toec,         "X.toec([curve = ECPt]) -> "
+                                      "X converted to elliptic curve point")
   METH (tobuf,         "X.tobuf() -> X in buffer representation")
   METH (toraw,         "X.toraw() -> X in raw representation")
 #undef METHNAME
@@ -1059,7 +1059,7 @@ static PyTypeObject ge_pytype_skel = {
     Py_TPFLAGS_BASETYPE,
 
   /* @tp_doc@ */
-"Group elements, abstract base class.",
+  "Group elements, abstract base class.",
 
   0,                                   /* @tp_traverse@ */
   0,                                   /* @tp_clear@ */
@@ -1096,8 +1096,7 @@ static PyGetSetDef group_pygetset[] = {
 
 static PyMethodDef group_pymethods[] = {
 #define METHNAME(name) gmeth_##name
-  METH (mexp,          "\
-G.mexp([(X0, N0), (X1, N1), ...]) -> X0^N0 X1^N1 ...")
+  METH (mexp,        "G.mexp([(X0, N0), (X1, N1), ...]) -> X0^N0 X1^N1 ...")
   KWMETH(checkgroup,   "G.checkgroup([rng = rand]): check group is good")
 #undef METHNAME
   { 0 }
@@ -1128,7 +1127,7 @@ static PyTypeObject group_pytype_skel = {
     Py_TPFLAGS_BASETYPE,
 
   /* @tp_doc@ */
-"Abstract base class for groups.",
+  "Abstract base class for groups.",
 
   0,                                   /* @tp_traverse@ */
   0,                                   /* @tp_clear@ */
@@ -1205,7 +1204,7 @@ static PyTypeObject primegroup_pytype_skel = {
     Py_TPFLAGS_BASETYPE,
 
   /* @tp_doc@ */
-"PrimeGroup(INFO): subgroups of prime fields.",
+  "PrimeGroup(INFO): subgroups of prime fields.",
 
   0,                                   /* @tp_traverse@ */
   0,                                   /* @tp_clear@ */
@@ -1282,7 +1281,7 @@ static PyTypeObject bingroup_pytype_skel = {
     Py_TPFLAGS_BASETYPE,
 
   /* @tp_doc@ */
-"BinGroup(INFO): subgroups of binary fields.",
+  "BinGroup(INFO): subgroups of binary fields.",
 
   0,                                   /* @tp_traverse@ */
   0,                                   /* @tp_clear@ */
@@ -1360,7 +1359,7 @@ static PyTypeObject ecgroup_pytype_skel = {
     Py_TPFLAGS_BASETYPE,
 
   /* @tp_doc@ */
-"ECGroup(INFO): elliptic curve groups.",
+  "ECGroup(INFO): elliptic curve groups.",
 
   0,                                   /* @tp_traverse@ */
   0,                                   /* @tp_clear@ */
@@ -1387,26 +1386,29 @@ static PyTypeObject ecgroup_pytype_skel = {
 
 static PyMethodDef methods[] = {
 #define METHNAME(name) meth_##name
-  METH (_GE_frombuf,           "frombuf(BUF) -> X, REST")
-  METH (_GE_fromraw,           "fromraw(BUF) -> X, REST")
-  METH (_GE_fromstring,        "fromstring(STR) -> X, REST")
-  METH (_Group_parse,          "parse(STR) -> G, REST")
-  METH (_DHInfo_parse,         "parse(STR) -> D, REST")
-  METH (_BinDHInfo_parse,      "parse(STR) -> D, REST")
-  METH (_DHInfo__groupn,       0)
-  METH (_BinDHInfo__groupn,    0)
-  KWMETH(_DHInfo_generate,     "\
-generate(PBITS, [qbits = 0], [event = pgen_nullev],\n\
-        [rng = rand], [nsteps = 0]) -> D")
-  KWMETH(_DHInfo_genlimlee,    "\
-genlimlee(PBITS, QBITS, [event = pgen_nullev], [ievent = pgen_nullev],\n\
-         [rng = rand], [nsteps = 0], [subgroupp = True]) -> (D, [Q, ...])")
-  KWMETH(_DHInfo_gendsa,       "\
-gendsa(PBITS, QBITS, SEED, [event = pgen_nullev], [nsteps = 0])\n\
-  -> (D, SEED, COUNT)")
-  KWMETH(_DHInfo_genkcdsa,     "\
-gendsa(PBITS, QBITS, [event = pgen_nullev], [rng = rand], [nsteps = 0])\n\
-  -> (D, V)")
+  METH (_GE_frombuf,   "frombuf(BUF) -> X, REST")
+  METH (_GE_fromraw,   "fromraw(BUF) -> X, REST")
+  METH (_GE_fromstring, "fromstring(STR) -> X, REST")
+  METH (_Group_parse,  "parse(STR) -> G, REST")
+  METH (_DHInfo_parse, "parse(STR) -> D, REST")
+  METH (_BinDHInfo_parse, "parse(STR) -> D, REST")
+  METH (_DHInfo__groupn, 0)
+  METH (_BinDHInfo__groupn, 0)
+  KWMETH(_DHInfo_generate,
+       "generate(PBITS, [qbits = 0, event = pgen_nullev,\n"
+       "        rng = rand, nsteps = 0]) -> D")
+  KWMETH(_DHInfo_genlimlee,
+       "genlimlee(PBITS, QBITS, [event = pgen_nullev], "
+                                                 "[ievent = pgen_nullev],\n"
+       "         [rng = rand], [nsteps = 0], [subgroupp = True]) "
+                                                         "-> (D, [Q, ...])")
+  KWMETH(_DHInfo_gendsa,
+       "gendsa(PBITS, QBITS, SEED, [event = pgen_nullev], [nsteps = 0])\n"
+       "  -> (D, SEED, COUNT)")
+  KWMETH(_DHInfo_genkcdsa,
+       "gendsa(PBITS, QBITS, [event = pgen_nullev], "
+                                             "[rng = rand], [nsteps = 0])\n"
+       "  -> (D, V)")
 #undef METHNAME
   { 0 }
 };