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

fix: convert numpy style docstrings to google type #202

Merged
merged 2 commits into from
Dec 30, 2024

Conversation

raspersc2
Copy link
Contributor

@raspersc2 raspersc2 commented Dec 30, 2024

Using fix conventional commit so docs actually build and deploy.

This should fix formatting of autodocs that somehow broke with numpy style

Other areas of project also need updating but this fixes the critical files for the docs

Using fix conventional commit so docs actually build and deploy.

This should fix formatting of autodocs that somehow broke
Copy link

github-actions bot commented Dec 30, 2024

Coverage

Coverage Report
FileStmtsMissCoverMissing
src/ares
   __init__.py20100% 
   behavior_exectioner.py15847%30–33, 47, 56–59
   cache.py160100% 
   config_parser.py271063%45, 48–49, 55, 76–90
   consts.py397499%179, 202, 206–207
   custom_bot_ai.py1014951%82–83, 130–139, 144–161, 187, 207–227, 241–288, 305–311, 319–332, 338, 362–363
   main.py40031820%80–114, 125, 128, 139–229, 241–257, 269–301, 355, 372–373, 377, 380–391, 407, 439–448, 462, 476–487, 501, 517, 530–531, 562–588, 610–626, 647–693, 702–718, 732–754, 763–765, 776–811, 829–838, 852–860, 891–976, 992, 1011, 1027–1045
src/ares/behaviors
   __init__.py10100% 
   behavior.py5180%25
src/ares/behaviors/combat
   __init__.py10100% 
   combat_maneuver.py14471%100–105
src/ares/behaviors/combat/group
   __init__.py70100% 
   a_move_group.py21767%38–50
   combat_group_behavior.py281161%29, 42, 46–56, 70–73
   group_use_ability.py24962%49–62
   keep_group_safe.py251060%42–55
   path_group_to_target.py391464%75–113
   stutter_group_back.py573146%50, 58–88, 93, 100–124
   stutter_group_forward.py422540%37–81
src/ares/behaviors/combat/individual
   __init__.py120100% 
   a_move.py130100% 
   attack_target.py130100% 
   combat_individual_behavior.py6183%29
   drop_cargo.py15473%43–47
   keep_unit_safe.py190100% 
   path_unit_to_target.py26196%66
   pick_up_cargo.py291066%54–73
   place_predictive_aoe.py61610%1–223
   shoot_target_in_range.py26869%49, 66–79
   stutter_unit_back.py261062%48–60
   stutter_unit_forward.py18667%41–47
   use_ability.py19668%49–57
   worker_kite_back.py18667%48–53
src/ares/behaviors/macro
   __init__.py140100% 
   addon_swap.py261254%47–88
   auto_supply.py562261%45–48, 55, 65, 72, 82–100, 119–126
   build_structure.py521865%77, 80, 83, 91, 110–115, 119–123, 126–144
   build_workers.py14471%36–48
   expansion_controller.py392049%48–64, 69–79, 97–116
   gas_building_controller.py251252%44–87
   macro_behavior.py6183%28
   macro_plan.py15567%47, 50–55
   mining.py21217318%88–250, 281, 286–316, 347–427, 467–542, 563–601, 607–614
   production_controller.py1299824%82–213, 226–246, 249–265, 270–287, 292–308
   restore_power.py432444%43–61, 78–89, 107–135
   spawn_controller.py1208529%82–229, 260–264, 291–300, 304–306, 312–322, 325–343
   tech_up.py775627%55–145, 166–211
   upgrade_controller.py402148%57–105
src/ares/build_runner
   __init__.py00100% 
   build_order_parser.py23118918%56–66, 159–160, 182–188, 214–215, 248–255, 260–329, 334–387, 392–397, 402–410, 429–446, 451–480, 483–528, 545–604
   build_order_runner.py33425125%117–163, 166–171, 174–175, 178–180, 202, 209, 220–239, 246–250, 263–464, 487–551, 568–574, 581–588, 591–604, 607–654, 667–677, 697–781
   build_order_step.py140100% 
src/ares/dicts
   __init__.py00100% 
   ability_cooldowns.py30100% 
   cost_dict.py30100% 
   does_not_use_larva.py30100% 
   enemy_detector_ranges.py40100% 
   enemy_vs_ground_static_defense_ranges.py30100% 
   pickup_range.py20100% 
   structure_to_building_size.py30100% 
   turn_rate.py440%1–7
   unit_alias.py20100% 
   unit_data.py30100% 
   unit_tech_requirement.py20100% 
   weight_costs.py30100% 
src/ares/managers
   __init__.py00100% 
   ability_tracker_manager.py30777%138–143, 231
   building_manager.py17812132%165–170, 192–321, 324–327, 330–335, 341–359, 390–464, 496, 521–527, 562, 589–594
   combat_sim_manager.py441761%150–157, 162–171
   data_manager.py804840%125, 129–134, 152–167, 171, 178–184, 189–194, 205–226, 229–235
   enemy_to_base_manager.py1004456%132, 168, 175, 194, 199, 217–222, 251–277, 292–295, 317–326, 335–349
   flying_structure_manager.py442152%62, 92, 128, 136–156, 159
   hub.py67987%195–196, 227–232, 247, 294
   intel_manager.py1154561%131–135, 199–215, 232–243, 260–286, 301, 315–331, 335, 344, 363–364, 367–368, 371–372, 389–390, 396–397, 406–407
   manager.py160100% 
   manager_mediator.py3307577%197, 276, 293, 308, 322, 341, 397, 478, 495, 511, 527, 544, 560, 576, 592, 609, 625, 644, 659, 673, 686, 701, 714, 763, 782, 837, 858, 965, 980, 1006, 1032, 1051, 1064, 1109, 1168, 1184, 1240, 1263, 1278, 1326, 1346, 1367, 1409, 1429, 1446, 1462, 1478, 1491, 1505, 1518, 1532, 1568, 1581, 1594, 1608, 1623, 1639, 1666, 1684, 1697, 1725, 1738, 1780, 1794, 1809, 1826, 1839, 1852, 1865, 1908, 1944, 1958, 1974, 1989, 2046
   path_manager.py2349958%243, 254–273, 406–411, 442–453, 510–514, 532–535, 541, 568, 596–611, 623, 635–638, 646–745, 748, 772–849, 868, 885, 903–905, 912, 928–935, 960, 1040–1041, 1055–1056, 1059, 1078–1080
   placement_manager.py45626243%195, 201, 204, 209, 258–263, 360, 370–387, 390–395, 401–434, 444, 458, 473, 490, 505, 518, 534, 540–681, 705–706, 726–751, 763–779, 792–812, 836–845, 865–874, 904, 933, 1035–1088, 1091–1115, 1151–1163, 1179–1212, 1258–1305, 1314–1347
   resource_manager.py28814151%153, 185–191, 255–258, 263, 304–312, 358–367, 370, 376, 383–452, 467, 471, 497–543, 566, 575–610, 686–693, 701–705, 720–723, 737–749, 763–765, 783–785, 812–828, 902, 905, 908, 934–940
   squad_manager.py18413228%51, 57, 60, 63, 66, 69–70, 168–170, 176–189, 216–241, 255, 281–293, 316–331, 346–360, 379–399, 402–406, 411–430, 436–447, 474–489, 503–525, 528–537
   terrain_manager.py1799249%190, 204–218, 234, 251–260, 272–275, 287, 302–305, 317, 329, 353, 365, 381–392, 443–469, 489–507, 563–583, 598–612, 625–639, 646–656
   unit_cache_manager.py1458641%160–166, 180–219, 232–238, 254–264, 275–281, 297–329, 342–351, 367–370, 386–390, 421, 459–469
   unit_memory_manager.py1778751%112–124, 172–211, 214, 239, 256–277, 293–294, 312–313, 333–337, 353–354, 370–372, 388–390, 412, 449, 492, 497–500, 521–523, 540–548, 569–589
   unit_role_manager.py862274%144–147, 161–165, 302, 377–392, 436
   warp_in_manager.py613543%84, 119–122, 125–198
TOTAL5819295249% 

Tests Skipped Failures Errors Time
198 0 💤 0 ❌ 0 🔥 2m 18s ⏱️

Some more docs converting
@raspersc2 raspersc2 merged commit 1130359 into main Dec 30, 2024
6 checks passed
@raspersc2 raspersc2 deleted the docs/comvert-docstrings branch January 1, 2025 10:40
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