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

mock: document public API in collector module #2389

Merged
merged 17 commits into from Jun 24, 2023
Merged

mock: document public API in collector module #2389

merged 17 commits into from Jun 24, 2023

Commits on Nov 16, 2022

  1. mock: document public API in collector module 

    There has been interest around publishing `tracing-mock` to crates.io
for some time. In order to make this possible, documentation and some
code clean up is needed.

This change adds documentation to the collector module itself and to all the
public APIs in the module. This includes doctests on all the methods
that serve as examples.

Additionally the implementation for the `Expect` struct has been moved
into the module with the definition, this was missed in #2369.

Refs: #539
    @hds
    hds committed Nov 16, 2022
    Configuration menu
    Copy the full SHA
    a5e7058 View commit details
    Browse the repository at this point in the history

Commits on Nov 18, 2022

  1. don't make MockCollector::drop_span deprecated 

    It creates too many issues (need to add `allow_deprecated` annotations
all over the place) and they will actually make fixing those tests to
use the new (but as yet unimplemented) `MockCollector::close_span` more
difficult.
    @hds
    hds committed Nov 18, 2022
    Configuration menu
    Copy the full SHA
    39045ed View commit details
    Browse the repository at this point in the history

  2. I was wondering whether missing docs were checked... 

    They are! I removed the referce to `MockCollector::close_span` as it
doesn't yet exist.
    @hds
    hds committed Nov 18, 2022
    Configuration menu
    Copy the full SHA
    fe92324 View commit details
    Browse the repository at this point in the history

Commits on Jan 4, 2023

  1. Merge branch 'master' of github.com:tokio-rs/tracing into hds/mock-co… 

    …llector-docs
    @hds
    hds committed Jan 4, 2023
    Configuration menu
    Copy the full SHA
    28b25fc View commit details
    Browse the repository at this point in the history

Commits on Jan 5, 2023

  1. added negative examples to most methods 

    Also cleaned up the text and tried to apply the code review comments
from #2426 to what I'd written already.
    @hds
    hds committed Jan 5, 2023
    Configuration menu
    Copy the full SHA
    b2816a2 View commit details
    Browse the repository at this point in the history

  2. typo fix

    @hds
    hds committed Jan 5, 2023
    Configuration menu
    Copy the full SHA
    299f093 View commit details
    Browse the repository at this point in the history

  3. Merge branch 'master' of github.com:tokio-rs/tracing into hds/mock-co… 

    …llector-docs
    @hds
    hds committed Jan 5, 2023
    Configuration menu
    Copy the full SHA
    d37a121 View commit details
    Browse the repository at this point in the history

Commits on Jan 9, 2023

  1. Apply suggestions from code review 

    Co-authored-by: Eliza Weisman <eliza@buoyant.io>
    @hds @hawkw
    hds and hawkw committed Jan 9, 2023
    Configuration menu
    Copy the full SHA
    757d877 View commit details
    Browse the repository at this point in the history

Commits on Jan 10, 2023

  1. Expanded collector module examples and other changes 

    All based on the lovely code review feedback I've been receiving.
    @hds
    hds committed Jan 10, 2023
    Configuration menu
    Copy the full SHA
    55901c8 View commit details
    Browse the repository at this point in the history

  2. Merge branch 'hds/mock-collector-docs' of github.com:tokio-rs/tracing… 

    … into hds/mock-collector-docs
    @hds
    hds committed Jan 10, 2023
    Configuration menu
    Copy the full SHA
    f24c2ed View commit details
    Browse the repository at this point in the history

  3. Update tracing-mock/src/collector.rs

    @hds
    hds committed Jan 10, 2023
    Configuration menu
    Copy the full SHA
    ca6b72a View commit details
    Browse the repository at this point in the history

Commits on Jan 18, 2023

  1. Ported some comments from #2446 

    The PR documenting the subscriber module.
    @hds
    hds committed Jan 18, 2023
    Configuration menu
    Copy the full SHA
    df486f9 View commit details
    Browse the repository at this point in the history

Commits on Jan 27, 2023

  1. Merge branch 'master' into hds/mock-collector-docs

    @davidbarsky
    davidbarsky committed Jan 27, 2023
    Configuration menu
    Copy the full SHA
    7264d25 View commit details
    Browse the repository at this point in the history

Commits on Jan 30, 2023

  1. Merge branch 'master' into hds/mock-collector-docs

    @hds
    hds committed Jan 30, 2023
    Configuration menu
    Copy the full SHA
    6b5740e View commit details
    Browse the repository at this point in the history

Commits on Apr 25, 2023

  1. Merge branch 'master' into hds/mock-collector-docs

    @hds
    hds committed Apr 25, 2023
    Configuration menu
    Copy the full SHA
    bc9c292 View commit details
    Browse the repository at this point in the history

Commits on Jun 19, 2023

  1. Merge branch 'master' into hds/mock-collector-docs

    @hds
    hds committed Jun 19, 2023
    Configuration menu
    Copy the full SHA
    0b8b99a View commit details
    Browse the repository at this point in the history

Commits on Jun 23, 2023

  1. Merge branch 'master' into hds/mock-collector-docs

    @hds
    hds committed Jun 23, 2023
    Configuration menu
    Copy the full SHA
    591cc79 View commit details
    Browse the repository at this point in the history