Docs: Clarify which kinds of options actually support "random" #2845
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
The current phrasing of this sentence made me expect "random" to work even on my OptionsDict option. After asking `#archipelago-dev` and checking the `Options.py` code, it's become clear that many option types don't (and can't) support "random". This is my best guess at a more correct wording.
github-actions
bot
added
the
is: documentation
github-actions
bot
added
the
waiting-on: peer-review
agilbert1412
approved these changes
Feb 20, 2024
agilbert1412
added
waiting-on: core-review
benny-dreamly
approved these changes
Feb 20, 2024
|
I read it. Looks good. |
|
Hm, this change makes it sound like you can't have a custom "random", but that's not true. You can override from_text to get custom behaviour for any Option type. Blasphemous and lufia2ac do this. |
|
Interesting. I would've read both the old and the new wording as excluding any way to implement it yourself. If anything, knowing it's not on some option types seems to open up the possibility. Maybe documenting that |
black-sliver
approved these changes
Feb 24, 2024
github-actions
bot
removed
the
waiting-on: core-review
ScipioWright
pushed a commit
to ScipioWright/Archipelago-SW
that referenced
this pull request
Feb 27, 2024
…pelagoMW#2845) * Clarify which kinds of options actually support "random" The current phrasing of this sentence made me expect "random" to work even on my OptionsDict option. After asking `#archipelago-dev` and checking the `Options.py` code, it's become clear that many option types don't (and can't) support "random". This is my best guess at a more correct wording. * add a sentence about from_text overrides based on black-silver's suggestion
Jouramie
pushed a commit
to Jouramie/Archipelago
that referenced
this pull request
Feb 28, 2024
…pelagoMW#2845) * Clarify which kinds of options actually support "random" The current phrasing of this sentence made me expect "random" to work even on my OptionsDict option. After asking `#archipelago-dev` and checking the `Options.py` code, it's become clear that many option types don't (and can't) support "random". This is my best guess at a more correct wording. * add a sentence about from_text overrides based on black-silver's suggestion
TheLX5
pushed a commit
to TheLX5/Archipelago
that referenced
this pull request
Mar 2, 2024
…pelagoMW#2845) * Clarify which kinds of options actually support "random" The current phrasing of this sentence made me expect "random" to work even on my OptionsDict option. After asking `#archipelago-dev` and checking the `Options.py` code, it's become clear that many option types don't (and can't) support "random". This is my best guess at a more correct wording. * add a sentence about from_text overrides based on black-silver's suggestion
TheLX5
pushed a commit
to TheLX5/Archipelago
that referenced
this pull request
Mar 2, 2024
…pelagoMW#2845) * Clarify which kinds of options actually support "random" The current phrasing of this sentence made me expect "random" to work even on my OptionsDict option. After asking `#archipelago-dev` and checking the `Options.py` code, it's become clear that many option types don't (and can't) support "random". This is my best guess at a more correct wording. * add a sentence about from_text overrides based on black-silver's suggestion
EmilyV99
pushed a commit
to EmilyV99/Archipelago
that referenced
this pull request
Apr 15, 2024
…pelagoMW#2845) * Clarify which kinds of options actually support "random" The current phrasing of this sentence made me expect "random" to work even on my OptionsDict option. After asking `#archipelago-dev` and checking the `Options.py` code, it's become clear that many option types don't (and can't) support "random". This is my best guess at a more correct wording. * add a sentence about from_text overrides based on black-silver's suggestion
EmilyV99
pushed a commit
to EmilyV99/Archipelago
that referenced
this pull request
Apr 15, 2024
…pelagoMW#2845) * Clarify which kinds of options actually support "random" The current phrasing of this sentence made me expect "random" to work even on my OptionsDict option. After asking `#archipelago-dev` and checking the `Options.py` code, it's become clear that many option types don't (and can't) support "random". This is my best guess at a more correct wording. * add a sentence about from_text overrides based on black-silver's suggestion
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 current phrasing of this sentence made me expect "random" to work on literally all options, even my
OptionsDictoption. After asking#archipelago-devand checking theOptions.pycode, it's become clear that many option kinds don't (and can't) support "random". After readingOptions.pya bit more, I believe this wording would be correct.How was this tested?
The change itself, N/A. It's just docs.
If you mean how I ran into this, I tried writing a test for my world with all options set to
"random", and gotNotImplementedError: Cannot Convert from non-dictionary, got <class 'str'>on theOptionsDictone.If this makes graphical changes, please attach screenshots.
N/A