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: add description of Indirect Condition problem #4295

Merged
merged 27 commits into from
Dec 12, 2024

Conversation

qwint
Copy link
Contributor

@qwint qwint commented Nov 30, 2024

What is this fixing or adding?

fix the last couple of wording issues I have with #3698
opened as a unique PR per permission from VI

How was this tested?

eyeballs

If this makes graphical changes, please attach screenshots.

NewSoupVi and others added 22 commits July 27, 2024 08:18
I wrote up a big effortpost about indirect conditions for nex on the [DS3 3.0 PR](ArchipelagoMW#3128 (comment)).

The version I'm [PRing to the world API document](ArchipelagoMW#3552) is very brief and unnuanced, because I'd rather people use too many indirect conditions than too few.
But that might leave some devs wanting to know more.

I think that comment on nex's DS3 PR is probably the best detailed explanation for indirect conditions that exists currently.

So I think it's good if it exists somewhere. And the FAQ doc seems like the best place right now, because I don't want to write an entirely new doc at the moment.
Co-authored-by: Scipio Wright <[email protected]>
Co-authored-by: Scipio Wright <[email protected]>
@github-actions github-actions bot added is: documentation Improvements or additions to documentation. waiting-on: peer-review Issue/PR has not been reviewed by enough people yet. labels Nov 30, 2024
@Jouramie
Copy link
Contributor

LGTM. This explains well the situation, why they are needed, how to opt-out and the drawbacks from opting out.

Copy link
Collaborator

@ScipioWright ScipioWright left a comment

Choose a reason for hiding this comment

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

Mostly conciseness stuff

docs/apworld_dev_faq.md Outdated Show resolved Hide resolved
docs/apworld_dev_faq.md Outdated Show resolved Hide resolved
docs/apworld_dev_faq.md Outdated Show resolved Hide resolved
docs/apworld_dev_faq.md Outdated Show resolved Hide resolved
docs/apworld_dev_faq.md Outdated Show resolved Hide resolved
docs/apworld_dev_faq.md Outdated Show resolved Hide resolved
docs/apworld_dev_faq.md Outdated Show resolved Hide resolved
docs/apworld_dev_faq.md Outdated Show resolved Hide resolved
qwint and others added 3 commits December 5, 2024 13:32
docs/apworld_dev_faq.md Outdated Show resolved Hide resolved
@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 Dec 12, 2024
@black-sliver black-sliver merged commit 1ca8d3e into ArchipelagoMW:main Dec 12, 2024
3 checks passed
@qwint qwint deleted the doc_indirect_connection branch December 12, 2024 20:25
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.

5 participants