Skip to content
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: Update advanced yaml guide wording for priority locations #3298

Merged
merged 6 commits into from
May 14, 2024

Conversation

ScipioWright
Copy link
Collaborator

What is this fixing or adding?

Currently, it says that priority_locations is the inverse of exclude_locations. This is not true, since neither exclude_locations nor priority_locations allow useful items.
I'm not a huge fan of the wording, I'm mostly just mirroring the exclude_locations text.

How was this tested?

Reading

If this makes graphical changes, please attach screenshots.

N/A

@ScipioWright ScipioWright added the is: documentation Improvements or additions to documentation. label May 13, 2024
@github-actions github-actions bot added the waiting-on: peer-review Issue/PR has not been reviewed by enough people yet. label May 13, 2024
Copy link
Contributor

@ShinyNT ShinyNT left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

short but sweet, the clearer the better

@Exempt-Medic
Copy link
Collaborator

Exempt-Medic commented May 13, 2024

May want to also change options api.md mentioning excluded locations

@ScipioWright ScipioWright added waiting-on: core-review Issue/PR has been peer-reviewed and is ready to be merged or needs input from a core maintainer. and removed waiting-on: peer-review Issue/PR has not been reviewed by enough people yet. labels May 14, 2024
Copy link
Collaborator

@Exempt-Medic Exempt-Medic left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Changes LGTM still.

@NewSoupVi NewSoupVi merged commit b78781a into ArchipelagoMW:main May 14, 2024
10 checks passed
@ScipioWright ScipioWright deleted the doc-fix branch May 14, 2024 19:33
jnschurig pushed a commit to Tranquilite0/Archipelago-SoulBlazer that referenced this pull request Jun 13, 2024
…ipelagoMW#3298)

* Update advanced yaml guide wording

* Update options api as well

* Update exclude locations description slightly to use more current verbiage

* Update priority locations in options api.md to note what happens if it runs out

* Remove auto-added bullet points

* Slightly mess with wording to make it more succinct
qwint pushed a commit to qwint/Archipelago that referenced this pull request Jun 24, 2024
…ipelagoMW#3298)

* Update advanced yaml guide wording

* Update options api as well

* Update exclude locations description slightly to use more current verbiage

* Update priority locations in options api.md to note what happens if it runs out

* Remove auto-added bullet points

* Slightly mess with wording to make it more succinct
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
is: documentation Improvements or additions to documentation. waiting-on: core-review Issue/PR has been peer-reviewed and is ready to be merged or needs input from a core maintainer.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants