HK: add location counts to option descriptions #4083
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
…by extracted data
github-actions
bot
added
the
waiting-on: peer-review
worlds/hk/Options.py
Outdated
| @@ -132,7 +132,8 @@ | |||
| for option_name, option_data in pool_options.items(): | |||
| extra_data = {"__module__": __name__, "items": option_data[0], "locations": option_data[1]} | |||
| if option_name in option_docstrings: | |||
| extra_data["__doc__"] = option_docstrings[option_name] | |||
| extra_data["__doc__"] = option_docstrings[option_name] + \ | |||
| f"\n This option adds {len(option_data[0])} location(s)" | |||
There was a problem hiding this comment.
You could do this (also adds a missing final period):
Suggested change
| f"\n This option adds {len(option_data[0])} location(s)" | |
| f"\n This option adds {len(option_data[0])} location{'' if len(option_data[0]) == 1 else 's'}." |
|
The changes LGTM overall. One comments on the "location(s)" made earlier, other than that Elevator Pass doesn't list a value and Nail claims it adds four locations when it's actually three. Split items also aren't listed but that seems fine. |
Exempt-Medic
added
is: enhancement
|
between this and #4079 whichever doesn't get merged first needs to update the other |
Exempt-Medic
removed
the
waiting-on: author
Exempt-Medic
approved these changes
Nov 24, 2024
|
Not a code reviewer, but if it works I'm very pro-adding this. Location count is very useful for organizing games, and knowing roughly how many locations a yaml adds without having to generate first is very useful for Joining games 👍 |
|
@BadMagic100 (since you asked for it) |
BadMagic100
reviewed
Dec 5, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
What is this fixing or adding?
adds auto generated location counts to options that update locations by extracted data
How was this tested?
lightly, looking at webhost and generated template yaml to make sure they read fine
If this makes graphical changes, please attach screenshots.