Doc improve

Author: hanke0

src/cachemap.c

@@ -686,10 +686,13 @@ static PyObject *CacheMap_clear(CtsCacheMap *self) {
 /* tp_methods */
 static PyMethodDef CacheMap_methods[] = {
     {"evict", (PyCFunction)CacheMap_evict, METH_NOARGS,
-     "evict()\n--\n\nEvict a item. raise error if no item in cache."
-     "no item in cache."},
-    {"set_capacity", (PyCFunction)CacheMap_set_capacity, METH_O,
-     "set_capacity(capacity, /)\n--\n\n Reset capacity of cache."},
+     "evict()\n--\n\nEvict a item. raise error if no item in cache."},
+    {
+        "set_capacity",
+        (PyCFunction)CacheMap_set_capacity,
+        METH_O,
+        "set_capacity(capacity, /)\n--\n\n Reset capacity of cache.",
+    },
     {"hit_info", (PyCFunction)CacheMap_hit_info, METH_NOARGS,
      "hit_info()\n--\n\nReturn capacity, hits, and misses count."},
     {"next_evict_key", (PyCFunction)CacheMap_NextEvictKey, METH_NOARGS,
@@ -703,9 +706,13 @@ static PyMethodDef CacheMap_methods[] = {
     {"pop", (PyCFunction)CacheMap_pop, METH_VARARGS | METH_KEYWORDS,
      "pop(key, default=None, /)\n--\n\nPop an item from cache, if key not "
      "exists return default."},
-    {"popitem", (PyCFunction)CacheMap_popitem, METH_NOARGS,
-     "popitem()\n--\n\nRemove and return some (key, value) pair"
-     "as a 2-tuple; but raise KeyError if mapping is empty."},
+    {
+        "popitem",
+        (PyCFunction)CacheMap_popitem,
+        METH_NOARGS,
+        "popitem()\n--\n\nRemove and return some (key, value) pair"
+        "as a 2-tuple; but raise KeyError if mapping is empty.",
+    },
     {"keys", (PyCFunction)CacheMap_keys, METH_NOARGS,
      "keys()\n--\n\nIter keys."},
     {"values", (PyCFunction)CacheMap_values, METH_NOARGS,
@@ -755,12 +762,12 @@ static PyObject *CacheMap_tp_richcompare(PyObject *self, PyObject *other,
 }
 
 PyDoc_STRVAR(CacheMap__doc__,
-             "CacheMap(maxsize=None, )\n--\n\n"
+             "CacheMap(capacity=None, )\n--\n\n"
              "A fast LFU (least frequently used) mapping.\n"
              "\n"
              "Parameters\n"
              "----------\n"
-             "maxsize : int\n"
+             "capacity : int, optional\n"
              "  Max size of cache, default is  C ``INT32_MAX``.\n"
              "\n"
              "Examples\n"

src/channel.c

@@ -432,7 +432,7 @@ PyDoc_STRVAR(Channel_safe_consume__doc__,
              "Safe consume with a callable.\n\n"
              "Parameters\n"
              "----------\n"
-             "fn : Callable[[Any], bool]\n"
+             "fn : typing.Callable[[typing.Any], bool]\n"
              "  The `fn` receive an item as only one argument and must return "
              "True on success, False on fail.\n"
              "\n"

src/pydoc.h

@@ -8,7 +8,7 @@
   "----------\n"                                                               \
   "key : object\n"                                                             \
   "  Hash key.\n"                                                              \
-  "fn : Typing.Callable[[typing.Any], typing.Any]\n"                           \
+  "fn : typing.Callable[[typing.Any], typing.Any], optional\n"                 \
   "  It's a callable that accept key as only one argument, called when key "   \
   "not exists.\n"                                                              \
   "\n"                                                                         \

src/rbtree.c

@@ -1227,11 +1227,11 @@ PyDoc_STRVAR(RBTree__doc__,
              "\n"
              "Parameters\n"
              "----------\n"
-             "cmp : typing.Callable[[typing.Any], int]\n"
-             "  A optional callable receive two keys, that\n"
-             "  return negative integer if `k1 < k2`, \n"
-             "  return positive integer if `k1 > k2`, \n"
-             "  return 0 if `k1 == k2`.\n"
+             "cmp : typing.Callable[[typing.Any], int], optional\n"
+             "  A optional callable receive two keys, that\n\n"
+             "  return negative integer if `k1 < k2`, \n\n"
+             "  return positive integer if `k1 > k2`, \n\n"
+             "  return 0 if `k1 == k2`.\n\n"
              "  It's every similar to standard C library qsort comparator.\n"
              "\n"
              "Examples\n"

src/ttlcache.c

@@ -692,7 +692,7 @@ PyDoc_STRVAR(
     "\n"
     "Parameters\n"
     "----------\n"
-    "ttl : int\n"
+    "ttl : int, optional\n"
     "  Key will expire after this many seconds, default is 60 (1 minute).\n"
     "\n"
     "Examples\n"