docs: refining docstrings, adding more examples

[aorumbayev]

Proposed changes

An aggregate PR to reflect and remaining last minutes suggestions tweaks in docs or docstrings prior to the final prod release. In addition addresses deprecation of asset_id parameter from fund method in TestNetDispenserClient, instead of removing it completely a deprecation with overload is used to minimize breaking changes.

[github-actions]

Coverage Report

File	Stmts	Miss	Cover	Missing
src/algokit_utils
_debugging.py	141	18	87%	21, 40–42, 45, 54, 62, 81, 87, 96, 110–114, 133, 141–143
account.py	3	3	0%	1–12
algorand.py	98	15	85%	64–65, 79–80, 110–111, 125–127, 138–139, 299, 322, 338, 357
application_client.py	3	3	0%	1–11
application_specification.py	7	7	0%	1–39
config.py	78	21	73%	23, 30–34, 73–74, 90, 95, 100, 111–116, 141, 144–146, 149, 151
deploy.py	3	3	0%	1–10
logic_error.py	3	3	0%	1–10
src/algokit_utils/_legacy_v2
_ensure_funded.py	72	1	99%	96
_transfer.py	73	3	96%	14, 78–79
account.py	93	13	86%	15–18, 71–75, 109, 126, 156, 159, 203
application_client.py	537	77	86%	56–57, 176, 181, 210, 322, 327–328, 330, 332, 801, 816, 834–837, 931, 971, 983, 996, 1038, 1098–1104, 1108–1113, 1115, 1151, 1158, 1271, 1307, 1321, 1359–1361, 1363, 1373–1430, 1441–1446, 1466–1469
asset.py	80	4	95%	24–27
common.py	13	1	92%	13
deploy.py	407	22	95%	32–35, 170, 174–175, 193, 249, 339–340, 361, 395, 406–414, 429, 437, 593–594, 618
network_clients.py	73	5	93%	79–80, 105–106, 139
src/algokit_utils/accounts
account_manager.py	244	33	86%	169, 185–186, 213–218, 236–237, 254, 271–276, 323–325, 354, 393, 413–417, 430, 489, 510, 667, 773, 852, 857, 872–873, 896
kmd_account_manager.py	74	10	86%	49–55, 96, 152, 159
src/algokit_utils/applications
abi.py	139	71	49%	14, 75, 111, 117, 119, 121, 125–126, 141–160, 176, 179–185, 201–214, 227–239, 254–265
app_client.py	742	214	71%	66–74, 133, 141, 328–331, 334, 337, 340, 343, 355–358, 361, 364, 367, 370, 382, 391, 400, 403–470, 483–541, 565–567, 584–587, 595–598, 606–609, 617–620, 628–631, 642–645, 658, 754–757, 791, 803, 815, 827, 839, 854, 869, 879, 889, 899, 909, 919, 956–969, 985, 1002, 1019, 1036, 1057, 1078, 1168, 1364, 1428–1429, 1478, 1480, 1486, 1539–1547, 1580–1583, 1586–1589, 1610, 1658, 1721–1723, 1736–1743, 1788, 1805, 1807, 1810, 1814, 1961, 1972–1973, 2001, 2011–2013, 2016–2038, 2048, 2057–2072, 2077–2082
app_deployer.py	230	35	85%	98, 272, 279, 289–294, 297–301, 373–374, 583, 592–595, 608, 613, 619, 628–633, 640, 669, 680–721
app_factory.py	271	27	90%	430, 451, 460, 652, 662, 712, 944, 958–963, 974–975, 1008, 1046, 1064–1065, 1108, 1116–1130
app_manager.py	218	16	93%	258, 341–342, 387–392, 424, 448–449, 479, 507–510, 542, 551
src/algokit_utils/applications/app_spec
arc32.py	95	8	92%	198–207
arc56.py	578	32	94%	71, 171, 292, 308–309, 379, 399–401, 453, 462, 464, 736, 750, 909, 911, 944–955, 968, 970–971, 987
src/algokit_utils/assets
asset_manager.py	128	12	91%	282–283, 292, 298–322, 332
src/algokit_utils/clients
client_manager.py	178	54	70%	24–26, 79–86, 111, 143–145, 205, 216–219, 244, 283, 318–323, 358–360, 393, 410, 432, 477–480, 520–523, 564–567, 604–607, 629–654, 692, 705, 717
dispenser_api_client.py	97	12	88%	137–138, 142–145, 201–203, 222–224
src/algokit_utils/errors
logic_error.py	56	11	80%	14, 105–121
src/algokit_utils/models
account.py	92	15	84%	32, 34, 80–81, 128, 136, 144, 168–175, 188, 196, 209, 217
amount.py	106	17	84%	35, 42, 88, 98, 104, 112, 117–119, 126, 131–133, 140, 147, 160, 166
application.py	66	1	98%	8
state.py	41	5	88%	60, 64–67
transaction.py	51	3	94%	66, 86, 91
src/algokit_utils/protocols
account.py	11	2	82%	17, 22
typed_clients.py	24	4	83%	12–24
src/algokit_utils/transactions
transaction_composer.py	1105	110	90%	34–41, 576, 621, 624, 629, 633–644, 676, 717, 784, 791, 813, 846, 943–972, 1001, 1019–1021, 1027–1042, 1047, 1055, 1057, 1059, 1075, 1081, 1119, 1127, 1140, 1234, 1284, 1733–1734, 1773–1774, 1815, 2029, 2032, 2051, 2056, 2080–2082, 2119–2155, 2162–2169, 2310, 2314, 2445, 2447–2448, 2498–2499
transaction_creator.py	75	7	91%	394, 427, 482, 520, 557, 590, 688
transaction_sender.py	162	10	94%	101, 270, 313–314, 713–718, 723–724, 889
TOTAL	6695	908	86%

Tests	Skipped	Failures	Errors	Time
404	0 💤	0 ❌	0 🔥	6m 6s ⏱️