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

Documentation for the test module #3023

Merged
merged 7 commits into from Nov 16, 2021
Merged

Documentation for the test module #3023

merged 7 commits into from Nov 16, 2021

Conversation

dkhalanskyjb
Copy link
Collaborator

Fixes #1390

qwwdfsad
qwwdfsad reviewed Nov 16, 2021
View reviewed changes
kotlinx-coroutines-test/MIGRATION.md Outdated Show resolved Hide resolved
kotlinx-coroutines-test/README.md Outdated Show resolved Hide resolved
kotlinx-coroutines-test/MIGRATION.md
## Remove custom `UncaughtExceptionCaptor`, `DelayController`, and `TestCoroutineScope` implementations

We couldn't find any code that defined new implementations of these interfaces, so they are deprecated. It's likely that
you don't need to do anything for this section.
Copy link
Member

Choose a reason for hiding this comment

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

It means that either this section should be moved to the bottom or the link to the next relevant section should be added

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

Not quite, these are listed step-by-step, and this step is the first one to perform.

Copy link
Member

@qwwdfsad qwwdfsad Nov 16, 2021 •
edited

Choose a reason for hiding this comment

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

Maybe then it's worth adding a link to the next paragraph?

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

Does this idea generalize to adding a link to the next section to every section? If not, I don't get it.

Copy link
Member

Choose a reason for hiding this comment

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

Well, it's not; this section is just likely to be skipped by a large portion of readers, thus the suggestion. I do not insist though

kotlinx-coroutines-test/MIGRATION.md Outdated Show resolved Hide resolved
Base automatically changed from coroutines-test-testScope to coroutines-test-virtualtime November 16, 2021 12:59
qwwdfsad
qwwdfsad approved these changes Nov 16, 2021
View reviewed changes
Copy link
Member

@qwwdfsad qwwdfsad left a comment

Choose a reason for hiding this comment

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

Please take a look at the compilation error and it's good to go

@dkhalanskyjb
Copy link
Collaborator Author

I needed to make TestDispatcher non-sealed again for the build to succeed: the JVM now has its own inheriting class.

@qwwdfsad
Copy link
Member

qwwdfsad commented Nov 16, 2021 •
edited

Sure, still good to go

@dkhalanskyjb dkhalanskyjb merged commit 35037ce into coroutines-test-virtualtime Nov 16, 2021
@dkhalanskyjb dkhalanskyjb deleted the coroutines-test-docs branch November 16, 2021 16:44
dkhalanskyjb added a commit that referenced this pull request Nov 17, 2021
@dkhalanskyjb
Documentation for the test module (#3023)
f6c8fdb 
Fixes #1390
dkhalanskyjb added a commit that referenced this pull request Nov 17, 2021
@dkhalanskyjb
Documentation for the test module (#3023)
5f79344 
Fixes #1390
dkhalanskyjb added a commit that referenced this pull request Nov 19, 2021
@dkhalanskyjb
Documentation for the test module (#3023)
ded719f 
Fixes #1390
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@qwwdfsad qwwdfsad Awaiting requested review from qwwdfsad

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

None yet
2 participants
@dkhalanskyjb @qwwdfsad