Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: final tweaks in docstrings (to be merged prior to prod release) #137

Open
wants to merge 3 commits into
base: main
Choose a base branch
from

Conversation

aorumbayev
Copy link
Contributor

Proposed changes

An aggregate PR to reflect and remaining last minutes suggestions tweaks in docs or docstrings prior to the final prod release

Copy link

github-actions bot commented Feb 10, 2025

Coverage

Coverage Report
FileStmtsMissCoverMissing
src/algokit_utils
   _debugging.py1411887%21, 40–42, 45, 54, 62, 81, 87, 96, 110–114, 133, 141–143
   account.py330%1–12
   algorand.py981585%62–63, 74–75, 95–96, 108–110, 119–120, 214, 234, 247, 263
   application_client.py330%1–11
   application_specification.py770%1–39
   config.py782173%23, 30–34, 73–74, 90, 95, 100, 111–116, 141, 144–146, 149, 151
   deploy.py330%1–10
   logic_error.py330%1–10
src/algokit_utils/_legacy_v2
   _ensure_funded.py72199%101
   _transfer.py73396%14, 78–79
   account.py931386%15–18, 71–75, 109, 126, 156, 159, 203
   application_client.py5377786%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.py80495%24–27
   common.py13192%13
   deploy.py4072394%32–35, 170, 174–175, 193, 208, 249, 339–340, 361, 395, 406–414, 429, 437, 593–594, 618
   network_clients.py73593%79–80, 105–106, 139
src/algokit_utils/accounts
   account_manager.py2133385%162, 181–182, 206–211, 229–230, 247, 264–269, 316–318, 347, 386, 406–410, 423, 482, 503, 660, 766, 845, 850, 869–870, 893
   kmd_account_manager.py741086%49–55, 96, 152, 159
src/algokit_utils/applications
   abi.py1327146%14, 77, 113, 119, 121, 123, 127–128, 143–162, 178, 181–187, 203–216, 229–241, 256–267
   app_client.py70221470%66–74, 133, 141, 335–338, 341, 344, 347, 350, 362–365, 368, 371, 374, 377, 389, 398, 407, 410–477, 490–548, 572–574, 591–594, 602–605, 613–616, 624–627, 635–638, 649–652, 665, 761–764, 798, 810, 822, 834, 846, 861, 876, 886, 896, 906, 916, 926, 963–976, 992, 1009, 1026, 1043, 1064, 1085, 1175, 1343, 1390–1391, 1422, 1424, 1430, 1475–1483, 1516–1519, 1522–1525, 1546, 1594, 1657–1659, 1672–1679, 1720, 1737, 1739, 1742, 1746, 1873, 1884–1885, 1908, 1918–1920, 1923–1945, 1955, 1964–1979, 1984–1989
   app_deployer.py2143584%98, 196, 203, 213–218, 221–225, 297–298, 507, 516–519, 532, 537, 543, 552–557, 564, 578, 589–630
   app_factory.py2662790%351, 361, 364, 508, 516, 528, 677, 691–696, 702–703, 721, 746, 757–758, 794, 802–816
   app_manager.py2181693%226, 285–286, 318–323, 349, 367–368, 398, 419–422, 445, 454
src/algokit_utils/applications/app_spec
   arc32.py95892%198–207
   arc56.py4703692%72–74, 183, 318, 336–337, 415, 437–439, 495, 504, 506, 574, 769, 779, 783, 943, 945, 978–989, 1002, 1004–1005, 1021
src/algokit_utils/assets
   asset_manager.py1061289%266–267, 276, 282–306, 316
src/algokit_utils/clients
   client_manager.py1735469%24–26, 74–81, 95, 127–129, 185, 196–199, 224, 263, 298–303, 338–340, 373, 390, 412, 446–449, 482–485, 519–522, 552–555, 573–598, 628, 637, 645
   dispenser_api_client.py841286%129–130, 134–137, 172–174, 193–195
src/algokit_utils/errors
   logic_error.py561180%14, 105–121
src/algokit_utils/models
   account.py881484%31, 33, 79–80, 127, 135, 159–166, 180–181, 189, 197
   amount.py1061784%35, 42, 88, 98, 104, 112, 117–119, 126, 131–133, 140, 147, 160, 166
   application.py42198%8
   state.py36586%51, 55–58
   transaction.py51394%66, 86, 91
src/algokit_utils/protocols
   account.py11282%17, 22
   typed_clients.py24483%12–24
src/algokit_utils/transactions
   transaction_composer.py95312887%34–41, 622, 625, 630, 634–645, 677, 718, 785, 792, 814, 847, 910–973, 1002, 1020–1022, 1028–1043, 1048, 1056, 1058, 1060, 1076, 1082, 1117–1124, 1127–1134, 1145, 1239, 1289, 1538–1539, 1578–1579, 1620, 1831, 1834, 1853, 1858, 1882–1884, 1921–1957, 1964–1971, 2112, 2115, 2241, 2243–2244, 2294–2295
   transaction_creator.py75791%116, 121, 126, 131, 136, 141, 156
   transaction_sender.py1481093%88, 243, 286–287, 431–436, 441–442, 487
TOTAL624993085% 

Tests Skipped Failures Errors Time
401 0 💤 0 ❌ 0 🔥 2m 50s ⏱️

@aorumbayev aorumbayev marked this pull request as ready for review February 11, 2025 14:44
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant