*.c: Reformat docstrings.

[catacomb-python] / key.c

diff --git a/key.c b/key.c
index b51c4567f44392d33d747eb36c11a36c5bb4e603..634eb290a427c7ddf25302d5a8784da2076b85a6 100644 (file)
--- a/key.c
+++ b/key.c
@@ -98,8 +98,8 @@ done:
 
 static PyMethodDef keyexc_pymethods[] = {
 #define METHNAME(func) kxmeth_##func
-  METH (__init__,              "KeyError(CODE)")
-  METH (__str__,               "E.__str__() -> STRING")
+  METH (__init__,      "KeyError(CODE)")
+  METH (__str__,       "E.__str__() -> STRING")
 #undef METHNAME
   { 0 }
 };
@@ -465,20 +465,20 @@ static PyObject *kdget_flags(PyObject *me, void *hunoz)
 
 static PyMethodDef keydata_pymethods[] = {
 #define METHNAME(func) kdmeth_##func
-  METH (matchp,                "KD.matchp(FILTER) -> BOOL")
-  METH (split,                 "KD.split()")
-  KWMETH(write,                        "KD.write([filter = <any>]) -> STRING")
-  KWMETH(encode,               "KD.encode([filter = <any>]) -> BYTES")
-  KWMETH(copy,                 "KD.copy([filter = <any>]) -> KD")
-  METH (plock,                 "KD.plock(TAG) -> ENCRYPTED-KD")
-  METH (lock,                  "KD.lock(KEY) -> ENCRYPTED-KD")
+  METH (matchp,        "KD.matchp(FILTER) -> BOOL")
+  METH (split,         "KD.split()")
+  KWMETH(write,                "KD.write([filter = <any>]) -> STRING")
+  KWMETH(encode,       "KD.encode([filter = <any>]) -> BYTES")
+  KWMETH(copy,         "KD.copy([filter = <any>]) -> KD")
+  METH (plock,         "KD.plock(TAG) -> ENCRYPTED-KD")
+  METH (lock,          "KD.lock(KEY) -> ENCRYPTED-KD")
 #undef METHNAME
   { 0 }
 };
 
 static PyGetSetDef keydata_pygetset[] = {
 #define GETSETNAME(op, name) kd##op##_##name
-  GET  (flags,                 "KD.flags -> FLAGS")
+  GET  (flags,         "KD.flags -> FLAGS")
 #undef GETSETNAME
   { 0 }
 };
@@ -508,7 +508,7 @@ static PyTypeObject keydata_pytype_skel = {
     Py_TPFLAGS_BASETYPE,
 
   /* @tp_doc@ */
-"Key data base class.",
+  "Key data base class.",
 
   0,                                   /* @tp_traverse@ */
   0,                                   /* @tp_clear@ */
@@ -555,7 +555,7 @@ static PyObject *kdbget_bin(PyObject *me, void *hunoz)
 
 static PyGetSetDef keydatabin_pygetset[] = {
 #define GETSETNAME(op, name) kdb##op##_##name
-  GET  (bin,                   "KD.bin -> BYTES")
+  GET  (bin,           "KD.bin -> BYTES")
 #undef GETSETNAME
   { 0 }
 };
@@ -585,7 +585,7 @@ static PyTypeObject keydatabin_pytype_skel = {
     Py_TPFLAGS_BASETYPE,
 
   /* @tp_doc@ */
-"KeyDataBinary(KEY, [flags = 0]): key data for binary keys.",
+  "KeyDataBinary(KEY, [flags = 0]): key data for binary keys.",
 
   0,                                   /* @tp_traverse@ */
   0,                                   /* @tp_clear@ */
@@ -682,17 +682,17 @@ end:
 
 static PyMethodDef keydataenc_pymethods[] = {
 #define METHNAME(func) kdemeth_##func
-  METH (plock,                 "KD.plock(TAG) -> ENCRYPTED-KD")
-  METH (lock,                  "KD.lock(KEY) -> ENCRYPTED-KD")
-  METH (punlock,               "KD.punlock(TAG) -> KD")
-  METH (unlock,                "KD.unlock(KEY) -> KD")
+  METH (plock,         "KD.plock(TAG) -> ENCRYPTED-KD")
+  METH (lock,          "KD.lock(KEY) -> ENCRYPTED-KD")
+  METH (punlock,       "KD.punlock(TAG) -> KD")
+  METH (unlock,        "KD.unlock(KEY) -> KD")
 #undef METHNAME
   { 0 }
 };
 
 static PyGetSetDef keydataenc_pygetset[] = {
 #define GETSETNAME(op, name) kde##op##_##name
-  GET  (ct,                    "KD.ct -> BYTES")
+  GET  (ct,            "KD.ct -> BYTES")
 #undef GETSETNAME
   { 0 }
 };
@@ -722,7 +722,7 @@ static PyTypeObject keydataenc_pytype_skel = {
     Py_TPFLAGS_BASETYPE,
 
   /* @tp_doc@ */
-"KeyDataEncrypted(KEY, [flags = 0]): key data for encrypted keys.",
+  "KeyDataEncrypted(KEY, [flags = 0]): key data for encrypted keys.",
 
   0,                                   /* @tp_traverse@ */
   0,                                   /* @tp_clear@ */
@@ -768,7 +768,7 @@ static PyObject *kdmget_mp(PyObject *me, void *hunoz)
 
 static PyGetSetDef keydatamp_pygetset[] = {
 #define GETSETNAME(op, name) kdm##op##_##name
-  GET  (mp,                    "KD.mp -> X")
+  GET  (mp,            "KD.mp -> X")
 #undef GETSETNAME
   { 0 }
 };
@@ -798,7 +798,7 @@ static PyTypeObject keydatamp_pytype_skel = {
     Py_TPFLAGS_BASETYPE,
 
   /* @tp_doc@ */
-"KeyDataMP(KEY, [flags = 0]): key data for large-integer keys.",
+  "KeyDataMP(KEY, [flags = 0]): key data for large-integer keys.",
 
   0,                                   /* @tp_traverse@ */
   0,                                   /* @tp_clear@ */
@@ -843,7 +843,7 @@ static PyObject *kdsget_str(PyObject *me, void *hunoz)
 
 static PyGetSetDef keydatastr_pygetset[] = {
 #define GETSETNAME(op, name) kds##op##_##name
-  GET  (str,                   "KD.str -> STRING")
+  GET  (str,           "KD.str -> STRING")
 #undef GETSETNAME
   { 0 }
 };
@@ -873,7 +873,7 @@ static PyTypeObject keydatastr_pytype_skel = {
     Py_TPFLAGS_BASETYPE,
 
   /* @tp_doc@ */
-"KeyDataString(KEY, [flags = 0]): key data for string keys.",
+  "KeyDataString(KEY, [flags = 0]): key data for string keys.",
 
   0,                                   /* @tp_traverse@ */
   0,                                   /* @tp_clear@ */
@@ -923,7 +923,7 @@ static PyObject *kdeget_ecpt(PyObject *me, void *hunoz)
 
 static PyGetSetDef keydataec_pygetset[] = {
 #define GETSETNAME(op, name) kde##op##_##name
-  GET  (ecpt,                  "KD.ecpt -> ECPT")
+  GET  (ecpt,          "KD.ecpt -> ECPT")
 #undef GETSETNAME
   { 0 }
 };
@@ -953,7 +953,7 @@ static PyTypeObject keydataec_pytype_skel = {
     Py_TPFLAGS_BASETYPE,
 
   /* @tp_doc@ */
-"KeyDataECPt(KEY, [flags = 0]): key data for elliptic-curve keys.",
+  "KeyDataECPt(KEY, [flags = 0]): key data for elliptic-curve keys.",
 
   0,                                   /* @tp_traverse@ */
   0,                                   /* @tp_clear@ */
@@ -1024,7 +1024,7 @@ static PyTypeObject subkeyiter_pytype_skel = {
     Py_TPFLAGS_BASETYPE,
 
   /* @tp_doc@ */
-"Iterator for structured keys.",
+  "Iterator for structured keys.",
 
   0,                                   /* @tp_traverse@ */
   0,                                   /* @tp_clear@ */
@@ -1159,7 +1159,7 @@ static PyTypeObject keydatastruct_pytype_skel = {
     Py_TPFLAGS_BASETYPE,
 
   /* @tp_doc@ */
-"KeyDataStructured([subkeys = []]): key data for structured keys.",
+  "KeyDataStructured([subkeys = []]): key data for structured keys.",
 
   0,                                   /* @tp_traverse@ */
   0,                                   /* @tp_clear@ */
@@ -1235,7 +1235,7 @@ static PyTypeObject keyattriter_pytype_skel = {
     Py_TPFLAGS_BASETYPE,
 
   /* @tp_doc@ */
-"Iterator for key attributes.",
+  "Iterator for key attributes.",
 
   0,                                   /* @tp_traverse@ */
   0,                                   /* @tp_clear@ */
@@ -1345,7 +1345,7 @@ static PyTypeObject keyattrs_pytype_skel = {
     Py_TPFLAGS_BASETYPE,
 
   /* @tp_doc@ */
-"Proxy thing for talking about key attributes.",
+  "Proxy thing for talking about key attributes.",
 
   0,                                   /* @tp_traverse@ */
   0,                                   /* @tp_clear@ */
@@ -1650,7 +1650,7 @@ static PyTypeObject key_pytype_skel = {
     Py_TPFLAGS_BASETYPE,
 
   /* @tp_doc@ */
-"Key(KF, ID, TYPE, [exptime = KEXP_FOREVER]): key object.",
+  "Key(KF, ID, TYPE, [exptime = KEXP_FOREVER]): key object.",
 
   0,                                   /* @tp_traverse@ */
   0,                                   /* @tp_clear@ */
@@ -1724,7 +1724,7 @@ static PyTypeObject keyiter_pytype_skel = {
     Py_TPFLAGS_BASETYPE,
 
   /* @tp_doc@ */
-"Keyring iterator.",
+  "Keyring iterator.",
 
   0,                                   /* @tp_traverse@ */
   0,                                   /* @tp_clear@ */
@@ -1994,8 +1994,8 @@ static PyMethodDef keyfile_pymethods[] = {
 #define METHNAME(func) kfmeth_##func
   METH (save,          "KF.save()")
   KWMETH(merge,                "KF.merge(FILE, [report = <built-in-reporter>])")
-  KWMETH(newkey,       "KF.newkey(ID, TYPE, "
-                               "[exptime = KEXP_FOREVER]) -> KEY")
+  KWMETH(newkey,       "KF.newkey(ID, TYPE, [exptime = KEXP_FOREVER]) "
+                                                                   "-> KEY")
   METH (byid,          "KF.byid(KEYID) -> KEY|None")
   METH (bytype,        "KF.bytype(TYPE) -> KEY|None")
   METH (bytag,         "KF.bytag(TAG) -> KEY|None")
@@ -2046,8 +2046,8 @@ static PyTypeObject keyfile_pytype_skel = {
     Py_TPFLAGS_BASETYPE,
 
   /* @tp_doc@ */
-"KeyFile(FILE, [how = KOPEN_READ], [report = ?]): Keyring file.\n\
-   calls REPORT(FILE, LINE, MSG) on problems",
+  "KeyFile(FILE, [how = KOPEN_READ], [report = ?]): Keyring file.\n"
+  "   calls REPORT(FILE, LINE, MSG) on problems",
 
   0,                                   /* @tp_traverse@ */
   0,                                   /* @tp_clear@ */
@@ -2074,11 +2074,11 @@ static PyTypeObject keyfile_pytype_skel = {
 
 static PyMethodDef methods[] = {
 #define METHNAME(func) meth_##func
-  METH (_KeyData_readflags,
-          "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.decode(BYTES) -> KD")
+  METH (_KeyData_readflags, "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.decode(BYTES) -> KD")
 #undef METHNAME
   { 0 }
 };