Docs: Update generate_output docstring
#2098
Merged
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
alwaysintreble
approved these changes
Aug 10, 2023
ThePhar
added
is: documentation
ThePhar
approved these changes
Aug 16, 2023
ThePhar
changed the title
generate_output docstring
ScipioWright
added a commit
to ScipioWright/Archipelago-SW
that referenced
this pull request
Aug 26, 2023
Updating the error message since it sent us on a wild goose chase looking to figure out why randoms were causing an error, where the actual error was from accidentally putting a Location into slot_data instead of its name. Also changing the recommendation from per_slot_randoms to self.random to mirror the change in PR ArchipelagoMW#2098 that got done last week.
FlySniper
pushed a commit
to FlySniper/Archipelago
that referenced
this pull request
Nov 14, 2023
Jouramie
pushed a commit
to Jouramie/Archipelago
that referenced
this pull request
Feb 28, 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?
The
generate_outputdocstring has become particularly confusing now that MultiWorld objects are being encouraged to be namedmultiworldandper_slot_randomsis deprecated in favor ofAutoWorld.random, which might now be confused with the termworld.random.Did a search for
world.randomin the whole codebase outside world implementations and didn't find any other documentation that looks like this.