Docs: minor updates to recommend modern PEP8 #2384
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
ScootyPuffJr1
added
the
is: documentation
docs/world api.md
Outdated
Comment on lines
229
to
230
| When imported names pile up it may be easier to use `from . import Options` | ||
| and access the variable as `Options.MyGameOptions`. | ||
| and access the variable as `options.MyGameOptions`. |
There was a problem hiding this comment.
I believe your change is incomplete
black-sliver
approved these changes
Nov 15, 2023
Jouramie
pushed a commit
to Jouramie/Archipelago
that referenced
this pull request
Feb 28, 2024
* docs: update world api for modern PEP8 conventions * docs: update options api for modern PEP8 styling * missed a spot
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?
Changes the recommendations to use modern PEP8 conventions, such as lower-case modules, and adds typing to all the example methods. Also gives a bit stronger example of
options.as_dictand recommends against setting up the world beforegenerate_earlyHow was this tested?
👀