Docs: Add documentation on writing and running tests #2348
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
el-u
reviewed
Oct 23, 2023
ScootyPuffJr1
added
the
is: documentation
There was a problem hiding this comment.
- I think there should be a sentence explaining when not to use WorldTestBase (i.e. https://github.com/ArchipelagoMW/Archipelago/blob/main/test/bases.py#L14 or a "raw" inittest.testcase)
- Suggestion below
|
I read it and after discussion with treble was able to undesrtand testing. I would suggest maybe adding the intended behaviour of the code snippet but other than that it was clear |
|
So, this is a bit concerning. The doc should be written in a way where you understand it without further discussion with treble 😅 |
black-sliver
approved these changes
Dec 1, 2023
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?
Docs. Definitely could use proof-reading.
How was this tested?
👀