Skip to content

Commit 75c87b8

Browse files
jph00jph00
committed
meta
1 parent 6907238 commit 75c87b8

File tree

1 file changed

+41
-39
lines changed

1 file changed

+41
-39
lines changed

‎nbs/04_docments.ipynb‎

Lines changed: 41 additions & 39 deletions
Original file line numberDiff line numberDiff line change
@@ -569,10 +569,10 @@
569569
{
570570
"data": {
571571
"text/plain": [
572-
"{'c': {'docment': 'First', 'anno': 'int', 'default': inspect._empty},\n",
573-
" 'b': {'docment': 'Second', 'anno': 'str', 'default': inspect._empty},\n",
574-
" 'a': {'docment': None, 'anno': 'int', 'default': 2},\n",
575-
" 'z': {'docment': None, 'anno': 'str', 'default': 'b'}}"
572+
"{'c': {'docment': 'First', 'anno': int, 'default': inspect._empty},\n",
573+
" 'b': {'docment': 'Second', 'anno': str, 'default': inspect._empty},\n",
574+
" 'a': {'docment': None, 'anno': int, 'default': 2},\n",
575+
" 'z': {'docment': None, 'anno': str, 'default': 'b'}}"
576576
]
577577
},
578578
"execution_count": null,
@@ -595,12 +595,12 @@
595595
{
596596
"data": {
597597
"text/plain": [
598-
"{'c': {'docment': 'First', 'anno': 'int', 'default': inspect._empty},\n",
599-
" 'b': {'docment': 'Second', 'anno': 'str', 'default': inspect._empty},\n",
600-
" 'a': {'docment': None, 'anno': 'int', 'default': 2},\n",
601-
" 'z': {'docment': None, 'anno': 'str', 'default': 'b'},\n",
598+
"{'c': {'docment': 'First', 'anno': int, 'default': inspect._empty},\n",
599+
" 'b': {'docment': 'Second', 'anno': str, 'default': inspect._empty},\n",
600+
" 'a': {'docment': None, 'anno': int, 'default': 2},\n",
601+
" 'z': {'docment': None, 'anno': str, 'default': 'b'},\n",
602602
" 'return': {'docment': 'Return an int',\n",
603-
" 'anno': 'int',\n",
603+
" 'anno': int,\n",
604604
" 'default': inspect._empty}}"
605605
]
606606
},
@@ -624,7 +624,7 @@
624624
{
625625
"data": {
626626
"text/plain": [
627-
"<function __main__._c(b: 'str', a: 'int' = 2, *, z: 'str' = 'b')>"
627+
"<function __main__._c(b: str, a: int = 2, *, z: str = 'b')>"
628628
]
629629
},
630630
"execution_count": null,
@@ -705,24 +705,26 @@
705705
"data": {
706706
"text/markdown": [
707707
"```python\n",
708-
"{ 'a': {'anno': 'int', 'default': 2, 'docment': None},\n",
709-
" 'b': { 'anno': 'str',\n",
708+
"{ 'a': {'anno': <class 'int'>, 'default': 2, 'docment': None},\n",
709+
" 'b': { 'anno': <class 'str'>,\n",
710710
" 'default': <class 'inspect._empty'>,\n",
711711
" 'docment': 'Second'},\n",
712-
" 'c': {'anno': 'int', 'default': <class 'inspect._empty'>, 'docment': 'First'},\n",
713-
" 'return': { 'anno': 'int',\n",
712+
" 'c': { 'anno': <class 'int'>,\n",
713+
" 'default': <class 'inspect._empty'>,\n",
714+
" 'docment': 'First'},\n",
715+
" 'return': { 'anno': <class 'int'>,\n",
714716
" 'default': <class 'inspect._empty'>,\n",
715717
" 'docment': 'Return an int'},\n",
716-
" 'z': {'anno': 'str', 'default': 'b', 'docment': 'Last'}}\n",
718+
" 'z': {'anno': <class 'str'>, 'default': 'b', 'docment': 'Last'}}\n",
717719
"```"
718720
],
719721
"text/plain": [
720-
"{'c': {'docment': 'First', 'anno': 'int', 'default': inspect._empty},\n",
721-
" 'b': {'docment': 'Second', 'anno': 'str', 'default': inspect._empty},\n",
722-
" 'a': {'docment': None, 'anno': 'int', 'default': 2},\n",
723-
" 'z': {'docment': 'Last', 'anno': 'str', 'default': 'b'},\n",
722+
"{'c': {'docment': 'First', 'anno': int, 'default': inspect._empty},\n",
723+
" 'b': {'docment': 'Second', 'anno': str, 'default': inspect._empty},\n",
724+
" 'a': {'docment': None, 'anno': int, 'default': 2},\n",
725+
" 'z': {'docment': 'Last', 'anno': str, 'default': 'b'},\n",
724726
" 'return': {'docment': 'Return an int',\n",
725-
" 'anno': 'int',\n",
727+
" 'anno': int,\n",
726728
" 'default': inspect._empty}}"
727729
]
728730
},
@@ -865,7 +867,7 @@
865867
"data": {
866868
"text/markdown": [
867869
"```python\n",
868-
"{ 'a': { 'anno': 'int',\n",
870+
"{ 'a': { 'anno': <class 'int'>,\n",
869871
" 'default': <class 'inspect._empty'>,\n",
870872
" 'docment': 'the 1st number to add'},\n",
871873
" 'args': { 'anno': <_ParameterKind.VAR_POSITIONAL: 2>,\n",
@@ -877,14 +879,14 @@
877879
" 'kwargs': { 'anno': <_ParameterKind.VAR_KEYWORD: 4>,\n",
878880
" 'default': <class 'inspect._empty'>,\n",
879881
" 'docment': None},\n",
880-
" 'return': { 'anno': 'int',\n",
882+
" 'return': { 'anno': <class 'int'>,\n",
881883
" 'default': <class 'inspect._empty'>,\n",
882884
" 'docment': 'the result of adding `a` to `b`'}}\n",
883885
"```"
884886
],
885887
"text/plain": [
886888
"{'a': {'docment': 'the 1st number to add',\n",
887-
" 'anno': 'int',\n",
889+
" 'anno': int,\n",
888890
" 'default': inspect._empty},\n",
889891
" 'args': {'docment': 'some args',\n",
890892
" 'anno': <_ParameterKind.VAR_POSITIONAL: 2>,\n",
@@ -894,7 +896,7 @@
894896
" 'anno': <_ParameterKind.VAR_KEYWORD: 4>,\n",
895897
" 'default': inspect._empty},\n",
896898
" 'return': {'docment': 'the result of adding `a` to `b`',\n",
897-
" 'anno': 'int',\n",
899+
" 'anno': int,\n",
898900
" 'default': inspect._empty}}"
899901
]
900902
},
@@ -925,13 +927,13 @@
925927
"data": {
926928
"text/markdown": [
927929
"```python\n",
928-
"{ 'anno': 'int',\n",
930+
"{ 'anno': <class 'int'>,\n",
929931
" 'default': <class 'inspect._empty'>,\n",
930932
" 'docment': 'the 1st number to add'}\n",
931933
"```"
932934
],
933935
"text/plain": [
934-
"{'docment': 'the 1st number to add', 'anno': 'int', 'default': inspect._empty}"
936+
"{'docment': 'the 1st number to add', 'anno': int, 'default': inspect._empty}"
935937
]
936938
},
937939
"execution_count": null,
@@ -953,13 +955,13 @@
953955
"data": {
954956
"text/markdown": [
955957
"```python\n",
956-
"{ 'anno': 'int',\n",
958+
"{ 'anno': <class 'int'>,\n",
957959
" 'default': <class 'inspect._empty'>,\n",
958960
" 'docment': 'the 1st number to add'}\n",
959961
"```"
960962
],
961963
"text/plain": [
962-
"{'docment': 'the 1st number to add', 'anno': 'int', 'default': inspect._empty}"
964+
"{'docment': 'the 1st number to add', 'anno': int, 'default': inspect._empty}"
963965
]
964966
},
965967
"execution_count": null,
@@ -1252,25 +1254,25 @@
12521254
"data": {
12531255
"text/markdown": [
12541256
"```python\n",
1255-
"{ 'a': { 'anno': 'int',\n",
1257+
"{ 'a': { 'anno': <class 'int'>,\n",
12561258
" 'default': <class 'inspect._empty'>,\n",
12571259
" 'docment': 'the first number to add'},\n",
12581260
" 'b': { 'anno': <class 'inspect._empty'>,\n",
12591261
" 'default': <class 'inspect._empty'>,\n",
12601262
" 'docment': 'the 2nd number to add (default: 0)'},\n",
1261-
" 'return': { 'anno': 'int',\n",
1263+
" 'return': { 'anno': <class 'int'>,\n",
12621264
" 'default': <class 'inspect._empty'>,\n",
12631265
" 'docment': 'the result'}}\n",
12641266
"```"
12651267
],
12661268
"text/plain": [
12671269
"{'a': {'docment': 'the first number to add',\n",
1268-
" 'anno': 'int',\n",
1270+
" 'anno': int,\n",
12691271
" 'default': inspect._empty},\n",
12701272
" 'b': {'docment': 'the 2nd number to add (default: 0)',\n",
12711273
" 'anno': inspect._empty,\n",
12721274
" 'default': inspect._empty},\n",
1273-
" 'return': {'docment': 'the result', 'anno': 'int', 'default': inspect._empty}}"
1275+
" 'return': {'docment': 'the result', 'anno': int, 'default': inspect._empty}}"
12741276
]
12751277
},
12761278
"execution_count": null,
@@ -1369,8 +1371,8 @@
13691371
"data": {
13701372
"text/markdown": [
13711373
"```python\n",
1372-
"{ 'a': {'anno': 'str', 'default': None, 'docment': 'First'},\n",
1373-
" 'b': { 'anno': 'str',\n",
1374+
"{ 'a': {'anno': <class 'str'>, 'default': None, 'docment': 'First'},\n",
1375+
" 'b': { 'anno': <class 'str'>,\n",
13741376
" 'default': <class 'inspect._empty'>,\n",
13751377
" 'docment': 'Second'},\n",
13761378
" 'return': { 'anno': <class 'inspect._empty'>,\n",
@@ -1379,8 +1381,8 @@
13791381
"```"
13801382
],
13811383
"text/plain": [
1382-
"{'b': {'docment': 'Second', 'anno': 'str', 'default': inspect._empty},\n",
1383-
" 'a': {'docment': 'First', 'anno': 'str', 'default': None},\n",
1384+
"{'b': {'docment': 'Second', 'anno': str, 'default': inspect._empty},\n",
1385+
" 'a': {'docment': 'First', 'anno': str, 'default': None},\n",
13841386
" 'return': {'docment': None,\n",
13851387
" 'anno': inspect._empty,\n",
13861388
" 'default': inspect._empty}}"
@@ -1840,7 +1842,7 @@
18401842
"| **Returns** | **int** | | |"
18411843
],
18421844
"text/plain": [
1843-
"DocmentTbl(obj=<function _f at 0x136709760>, dm={'a': {'docment': 'description of param a', 'anno': <class 'inspect._empty'>, 'default': <class 'inspect._empty'>}, 'b': {'docment': 'description of param b', 'anno': <class 'bool'>, 'default': True}, 'c': {'docment': <class 'inspect._empty'>, 'anno': <class 'str'>, 'default': None}, 'return': {'docment': <class 'inspect._empty'>, 'anno': <class 'int'>, 'default': <class 'inspect._empty'>}}, verbose=True, returns=True, params=['a', 'b', 'c'])"
1845+
"DocmentTbl(obj=<function _f at 0x1361a9300>, dm={'a': {'docment': 'description of param a', 'anno': <class 'inspect._empty'>, 'default': <class 'inspect._empty'>}, 'b': {'docment': 'description of param b', 'anno': <class 'bool'>, 'default': True}, 'c': {'docment': <class 'inspect._empty'>, 'anno': <class 'str'>, 'default': None}, 'return': {'docment': <class 'inspect._empty'>, 'anno': <class 'int'>, 'default': <class 'inspect._empty'>}}, verbose=True, returns=True, params=['a', 'b', 'c'])"
18441846
]
18451847
},
18461848
"execution_count": null,
@@ -1918,7 +1920,7 @@
19181920
"| **Returns** | **str** | | **Result of doing it** |"
19191921
],
19201922
"text/plain": [
1921-
"DocmentTbl(obj=<function _f at 0x1367087c0>, dm={'a': {'docment': <class 'inspect._empty'>, 'anno': <class 'inspect._empty'>, 'default': <class 'inspect._empty'>}, 'b': {'docment': 'param b', 'anno': <class 'int'>, 'default': <class 'inspect._empty'>}, 'c': {'docment': 'param c', 'anno': <class 'str'>, 'default': 'foo'}, 'return': {'docment': 'Result of doing it', 'anno': <class 'str'>, 'default': <class 'inspect._empty'>}}, verbose=True, returns=True, params=['a', 'b', 'c'])"
1923+
"DocmentTbl(obj=<function _f at 0x1361a91c0>, dm={'a': {'docment': <class 'inspect._empty'>, 'anno': <class 'inspect._empty'>, 'default': <class 'inspect._empty'>}, 'b': {'docment': 'param b', 'anno': <class 'int'>, 'default': <class 'inspect._empty'>}, 'c': {'docment': 'param c', 'anno': <class 'str'>, 'default': 'foo'}, 'return': {'docment': 'Result of doing it', 'anno': <class 'str'>, 'default': <class 'inspect._empty'>}}, verbose=True, returns=True, params=['a', 'b', 'c'])"
19221924
]
19231925
},
19241926
"execution_count": null,
@@ -2011,7 +2013,7 @@
20112013
"| d | bool | True | description of param d |"
20122014
],
20132015
"text/plain": [
2014-
"DocmentTbl(obj=<function _Test.foo at 0x1367491c0>, dm={'c': {'docment': 'description of param c', 'anno': <class 'int'>, 'default': <class 'inspect._empty'>}, 'd': {'docment': 'description of param d', 'anno': <class 'bool'>, 'default': True}, 'return': {'docment': <class 'inspect._empty'>, 'anno': <class 'inspect._empty'>, 'default': <class 'inspect._empty'>}}, verbose=True, returns=True, params=['self', 'c', 'd'])"
2016+
"DocmentTbl(obj=<function _Test.foo at 0x1361a9120>, dm={'c': {'docment': 'description of param c', 'anno': <class 'int'>, 'default': <class 'inspect._empty'>}, 'd': {'docment': 'description of param d', 'anno': <class 'bool'>, 'default': True}, 'return': {'docment': <class 'inspect._empty'>, 'anno': <class 'inspect._empty'>, 'default': <class 'inspect._empty'>}}, verbose=True, returns=True, params=['self', 'c', 'd'])"
20152017
]
20162018
},
20172019
"execution_count": null,

0 commit comments

Comments
 (0)