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.

Sign up for GitHub

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

Jump to bottom

Docs: Add documentation on writing and running tests #2348

Merged
merged 4 commits into from
Dec 1, 2023
Merged

Docs: Add documentation on writing and running tests #2348

merged 4 commits into from
Dec 1, 2023

Conversation

alwaysintreble
Copy link
Collaborator

What is this fixing or adding?

Docs. Definitely could use proof-reading.

How was this tested?

👀

el-u
el-u reviewed Oct 23, 2023
View reviewed changes
docs/tests.md Outdated Show resolved Hide resolved
docs/tests.md Outdated Show resolved Hide resolved
docs/tests.md Outdated Show resolved Hide resolved
docs/tests.md Outdated Show resolved Hide resolved
docs/tests.md Outdated Show resolved Hide resolved
docs/tests.md Outdated Show resolved Hide resolved
docs/tests.md Outdated Show resolved Hide resolved
docs/tests.md Outdated Show resolved Hide resolved
docs/tests.md Outdated Show resolved Hide resolved
docs/tests.md Outdated Show resolved Hide resolved
@ScootyPuffJr1 ScootyPuffJr1 added the is: documentation Improvements or additions to documentation. label Oct 23, 2023
black-sliver
black-sliver reviewed Nov 15, 2023
View reviewed changes
Copy link
Member

@black-sliver black-sliver left a comment

Choose a reason for hiding this comment

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

  1. 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)
  2. Suggestion below

docs/tests.md Outdated Show resolved Hide resolved
@black-sliver black-sliver mentioned this pull request Nov 15, 2023
Merged
@ReverM
Copy link
Contributor

ReverM commented Nov 28, 2023

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

@black-sliver
Copy link
Member

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
black-sliver approved these changes Dec 1, 2023
View reviewed changes
Copy link
Member

@black-sliver black-sliver left a comment

Choose a reason for hiding this comment

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

The "further discussion" was about something deemed out of scope for this doc, so it should be fine.

@black-sliver black-sliver merged commit c7d4c2f into ArchipelagoMW:main Dec 1, 2023
Jouramie pushed a commit to Jouramie/Archipelago that referenced this pull request Feb 28, 2024
@alwaysintreble @Jouramie
Docs: Add documentation on writing and running tests (ArchipelagoMW#2348
c85ea7b 
)

* Docs: Add documentation on writing and running tests

* review improvements

* sliver requests
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@el-u el-u el-u left review comments

@black-sliver black-sliver black-sliver approved these changes

Assignees
No one assigned
Labels
is: documentation Improvements or additions to documentation.
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

None yet
5 participants
@alwaysintreble @ReverM @black-sliver @el-u @ScootyPuffJr1