Docs: Add detail on customizing the forced groups #3371
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
…customizing the forced groups.
github-actions
bot
added
is: documentation
Exempt-Medic
requested changes
May 22, 2024
docs/options api.md
Outdated
| removed from this group. | ||
|
|
||
| Both the "Game Options" and "Item & Location Options" groups can be overridden by creating your own groups with | ||
| those names, and specify specific options to add to them, as well as change the visibility. The "Item & Location |
There was a problem hiding this comment.
Suggested change
| those names, and specify specific options to add to them, as well as change the visibility. The "Item & Location | |
| those names, and specifying specific options to add to them, as well as change the visibility. The "Item & Location |
I'm not entirely sure what "as well as change the visibility" is meant to refer to here. Is it the visibility of the options that are in those groups by default?
There was a problem hiding this comment.
so i suppose that should be start_collapsed?
There was a problem hiding this comment.
Could put it in a clause near the start, like:
Both the "Game Options" and "Item & Location Options" groups can be overridden, including their
start_collapsedvalue, by creating your own groups with those names, and specifying specific options to add to them.
Co-authored-by: Exempt-Medic <60412657+Exempt-Medic@users.noreply.github.com>
Co-authored-by: Exempt-Medic <60412657+Exempt-Medic@users.noreply.github.com>
nicholassaylor
approved these changes
Jun 3, 2024
Exempt-Medic
added
waiting-on: core-review
NewSoupVi
approved these changes
Jun 4, 2024
wu4
pushed a commit
to wu4/Archipelago
that referenced
this pull request
Jun 6, 2024
* Docs: Fix incorrect assertion in option group docs and add detail on customizing the forced groups. * add docs for the visibility attribute * typos * review comments * missed one Co-authored-by: Exempt-Medic <60412657+Exempt-Medic@users.noreply.github.com> * better wording Co-authored-by: Exempt-Medic <60412657+Exempt-Medic@users.noreply.github.com> --------- Co-authored-by: Exempt-Medic <60412657+Exempt-Medic@users.noreply.github.com>
agilbert1412
pushed a commit
to agilbert1412/Archipelago
that referenced
this pull request
Jun 13, 2024
* Docs: Fix incorrect assertion in option group docs and add detail on customizing the forced groups. * add docs for the visibility attribute * typos * review comments * missed one Co-authored-by: Exempt-Medic <60412657+Exempt-Medic@users.noreply.github.com> * better wording Co-authored-by: Exempt-Medic <60412657+Exempt-Medic@users.noreply.github.com> --------- Co-authored-by: Exempt-Medic <60412657+Exempt-Medic@users.noreply.github.com>
jnschurig
pushed a commit
to Tranquilite0/Archipelago-SoulBlazer
that referenced
this pull request
Jun 13, 2024
* Docs: Fix incorrect assertion in option group docs and add detail on customizing the forced groups. * add docs for the visibility attribute * typos * review comments * missed one Co-authored-by: Exempt-Medic <60412657+Exempt-Medic@users.noreply.github.com> * better wording Co-authored-by: Exempt-Medic <60412657+Exempt-Medic@users.noreply.github.com> --------- Co-authored-by: Exempt-Medic <60412657+Exempt-Medic@users.noreply.github.com>
sflavelle
pushed a commit
to sflavelle/Archipelago-tgc
that referenced
this pull request
Jun 20, 2024
* Docs: Fix incorrect assertion in option group docs and add detail on customizing the forced groups. * add docs for the visibility attribute * typos * review comments * missed one Co-authored-by: Exempt-Medic <60412657+Exempt-Medic@users.noreply.github.com> * better wording Co-authored-by: Exempt-Medic <60412657+Exempt-Medic@users.noreply.github.com> --------- Co-authored-by: Exempt-Medic <60412657+Exempt-Medic@users.noreply.github.com>
qwint
pushed a commit
to qwint/Archipelago
that referenced
this pull request
Jun 24, 2024
* Docs: Fix incorrect assertion in option group docs and add detail on customizing the forced groups. * add docs for the visibility attribute * typos * review comments * missed one Co-authored-by: Exempt-Medic <60412657+Exempt-Medic@users.noreply.github.com> * better wording Co-authored-by: Exempt-Medic <60412657+Exempt-Medic@users.noreply.github.com> --------- Co-authored-by: Exempt-Medic <60412657+Exempt-Medic@users.noreply.github.com>
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?
Fixes an incorrect assertion on the ordering of option groups and adds detail on the two auto generated groups as well as how you can customize them.
How was this tested?
👁️