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

Extend the KDoc for CoroutineStart #4147

Merged
merged 17 commits into from
Aug 12, 2024
Merged

Extend the KDoc for CoroutineStart #4147

merged 17 commits into from
Aug 12, 2024

Commits on Jul 30, 2024

  1. Reduce duplication across the docs of the CoroutineStart entries 

    All of them except `LAZY` mentioned that cancellability at
suspension points depends on the specific suspending functions,
and it looks like it applies to `LAZY`, so this information is
moved to `CoroutineStart`'s top-level documentation.
    @globsterg @dkhalanskyjb
    globsterg authored and dkhalanskyjb committed Jul 30, 2024
    Configuration menu
    Copy the full SHA
    f8c0206 View commit details
    Browse the repository at this point in the history

  2. Remove a redundant import 

    Presumably, the import statement was used to ensure that the
symbols in the documentation are properly resolved.
It does not seem to be necessary at the moment.
    @globsterg @dkhalanskyjb
    globsterg authored and dkhalanskyjb committed Jul 30, 2024
    Configuration menu
    Copy the full SHA
    5149c6d View commit details
    Browse the repository at this point in the history

  3. Extend the documentation for CoroutineStart.LAZY

    @globsterg @dkhalanskyjb
    globsterg authored and dkhalanskyjb committed Jul 30, 2024
    Configuration menu
    Copy the full SHA
    200e6b4 View commit details
    Browse the repository at this point in the history

  4. Slightly reword the CoroutineStart documentation

    @globsterg @dkhalanskyjb
    globsterg authored and dkhalanskyjb committed Jul 30, 2024
    Configuration menu
    Copy the full SHA
    22bc930 View commit details
    Browse the repository at this point in the history

  5. Extend the documentation for CoroutineStart.DEFAULT

    @globsterg @dkhalanskyjb
    globsterg authored and dkhalanskyjb committed Jul 30, 2024
    Configuration menu
    Copy the full SHA
    fc8e2ad View commit details
    Browse the repository at this point in the history

  6. Add samples to CoroutineStart.LAZY

    @globsterg @dkhalanskyjb
    globsterg authored and dkhalanskyjb committed Jul 30, 2024
    Configuration menu
    Copy the full SHA
    2549a23 View commit details
    Browse the repository at this point in the history

  7. Extend the documentation for CoroutineStart.ATOMIC

    @globsterg @dkhalanskyjb
    globsterg authored and dkhalanskyjb committed Jul 30, 2024
    Configuration menu
    Copy the full SHA
    f6ca16d View commit details
    Browse the repository at this point in the history

  8. Extend the documentation for CoroutineStart.UNDISPATCHED

    @globsterg @dkhalanskyjb
    globsterg authored and dkhalanskyjb committed Jul 30, 2024
    Configuration menu
    Copy the full SHA
    613fac0 View commit details
    Browse the repository at this point in the history

  9. Add examples of when CoroutineStart.(ATOMIC|UNDISPATCHED) are used 

    After playing around with CoroutineStart.LAZY,
I failed to understand when it can be useful.
    @globsterg @dkhalanskyjb
    globsterg authored and dkhalanskyjb committed Jul 30, 2024
    Configuration menu
    Copy the full SHA
    ef2fba0 View commit details
    Browse the repository at this point in the history

  10. Apply suggestions from code review 

    Co-authored-by: Vsevolod Tolstopyatov <qwwdfsad@gmail.com>
    @globsterg @qwwdfsad @dkhalanskyjb
    2 people authored and dkhalanskyjb committed Jul 30, 2024
    Configuration menu
    Copy the full SHA
    74e3f0b View commit details
    Browse the repository at this point in the history

  11. Address the review

    @globsterg @dkhalanskyjb
    globsterg authored and dkhalanskyjb committed Jul 30, 2024
    Configuration menu
    Copy the full SHA
    049b554 View commit details
    Browse the repository at this point in the history

  12. Address the review further

    @dkhalanskyjb
    dkhalanskyjb committed Jul 30, 2024
    Configuration menu
    Copy the full SHA
    bc48938 View commit details
    Browse the repository at this point in the history

  13. Explain the typical dispatch procedure in CoroutineDispatcher docs

    @dkhalanskyjb
    dkhalanskyjb committed Jul 30, 2024
    Configuration menu
    Copy the full SHA
    404e155 View commit details
    Browse the repository at this point in the history

Commits on Aug 1, 2024

  1. Mention that LAZY is often not the best choice

    @dkhalanskyjb
    dkhalanskyjb committed Aug 1, 2024
    Configuration menu
    Copy the full SHA
    4483187 View commit details
    Browse the repository at this point in the history

Commits on Aug 2, 2024

  1. Fixes

    @dkhalanskyjb
    dkhalanskyjb committed Aug 2, 2024
    Configuration menu
    Copy the full SHA
    0a9b4ea View commit details
    Browse the repository at this point in the history

Commits on Aug 5, 2024

  1. Highlight lazy's behavior

    @dkhalanskyjb
    dkhalanskyjb committed Aug 5, 2024
    Configuration menu
    Copy the full SHA
    5261f69 View commit details
    Browse the repository at this point in the history

Commits on Aug 12, 2024

  1. Small fixes

    @dkhalanskyjb
    dkhalanskyjb committed Aug 12, 2024
    Configuration menu
    Copy the full SHA
    762a90b View commit details
    Browse the repository at this point in the history