-
Notifications
You must be signed in to change notification settings - Fork 657
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Docs: Add detail on customizing the forced groups #3371
Conversation
…customizing the forced groups.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Some small fixes
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.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
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.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
so i suppose that should be start_collapsed
?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
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_collapsed
value, by creating your own groups with those names, and specifying specific options to add to them.
Co-authored-by: Exempt-Medic <[email protected]>
Co-authored-by: Exempt-Medic <[email protected]>
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Docs are clear and make sense, LGTM
* 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 <[email protected]> * better wording Co-authored-by: Exempt-Medic <[email protected]> --------- Co-authored-by: Exempt-Medic <[email protected]>
* 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 <[email protected]> * better wording Co-authored-by: Exempt-Medic <[email protected]> --------- Co-authored-by: Exempt-Medic <[email protected]>
* 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 <[email protected]> * better wording Co-authored-by: Exempt-Medic <[email protected]> --------- Co-authored-by: Exempt-Medic <[email protected]>
* 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 <[email protected]> * better wording Co-authored-by: Exempt-Medic <[email protected]> --------- Co-authored-by: Exempt-Medic <[email protected]>
* 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 <[email protected]> * better wording Co-authored-by: Exempt-Medic <[email protected]> --------- Co-authored-by: Exempt-Medic <[email protected]>
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?
👁️