Templates: Remove auto wordwrap, fix manual indentation, and reformat docstrings for world options in main. (#1201)

* Fix wrapping too early if docstring is within 120 characters and re-indent other lines.

* Remove auto-word wrapping and tweaked all worlds' option docstrings formatting.

Options should wrap around the 120 character mark to prevent template files from being too long horizontally. This also allows manual-indentation to work again.

* Fix missing '#' on empty lines in output from docstring.
This commit is contained in:
Zach Parks
2022-11-06 08:28:16 -06:00
committed by GitHub
parent d10bb3c6c1
commit 462ddce72c
13 changed files with 142 additions and 82 deletions

View File

@@ -13,16 +13,16 @@ class GameDifficulty(Choice):
class UpgradeBonus(Choice):
"""Determines what lab upgrade to use, whether it is Ultra-Capacitors which boost attack speed with every weapon upgrade
or Vanadium Plating which boosts life with every armor upgrade."""
"""Determines what lab upgrade to use, whether it is Ultra-Capacitors which boost attack speed with every weapon
upgrade or Vanadium Plating which boosts life with every armor upgrade."""
display_name = "Upgrade Bonus"
option_ultra_capacitors = 0
option_vanadium_plating = 1
class BunkerUpgrade(Choice):
"""Determines what bunker lab upgrade to use, whether it is Shrike Turret which outfits bunkers with an automated turret or
Fortified Bunker which boosts the life of bunkers."""
"""Determines what bunker lab upgrade to use, whether it is Shrike Turret which outfits bunkers with an automated
turret or Fortified Bunker which boosts the life of bunkers."""
display_name = "Bunker Upgrade"
option_shrike_turret = 0
option_fortified_bunker = 1
@@ -56,14 +56,17 @@ class MissionOrder(Choice):
class ShuffleProtoss(DefaultOnToggle):
"""Determines if the 3 protoss missions are included in the shuffle if Vanilla mission order is not enabled.
If turned off with Vanilla Shuffled, the 3 protoss missions will be in their normal position on the Prophecy chain if not shuffled.
If turned off with reduced mission settings, the 3 protoss missions will not appear and Protoss units are removed from the pool."""
If turned off with Vanilla Shuffled, the 3 protoss missions will be in their normal position on the Prophecy chain
if not shuffled.
If turned off with reduced mission settings, the 3 protoss missions will not appear and Protoss units are removed
from the pool."""
display_name = "Shuffle Protoss Missions"
class ShuffleNoBuild(DefaultOnToggle):
"""Determines if the 5 no-build missions are included in the shuffle if Vanilla mission order is not enabled.
If turned off with Vanilla Shuffled, one no-build mission will be placed as the first mission and the rest will be placed at the end of optional routes.
If turned off with Vanilla Shuffled, one no-build mission will be placed as the first mission and the rest will be
placed at the end of optional routes.
If turned off with reduced mission settings, the 5 no-build missions will not appear."""
display_name = "Shuffle No-Build Missions"
@@ -74,7 +77,9 @@ class EarlyUnit(DefaultOnToggle):
class RequiredTactics(Choice):
"""Determines the maximum tactical difficulty of the seed (separate from mission difficulty). Higher settings increase randomness.
"""Determines the maximum tactical difficulty of the seed (separate from mission difficulty). Higher settings
increase randomness.
Standard: All missions can be completed with good micro and macro.
Advanced: Completing missions may require relying on starting units and micro-heavy units.
No Logic: Units and upgrades may be placed anywhere. LIKELY TO RENDER THE RUN IMPOSSIBLE ON HARDER DIFFICULTIES!"""