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.

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

update some out-of-date comments and documentation #176

Merged
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 1 addition & 2 deletions include/datadog/null_collector.h
Original file line number Diff line number Diff line change
@@ -1,8 +1,7 @@
#pragma once

// This component provides a `class`, `NullCollector`, that implements the
// `Collector` interface in terms of a no-op. It's used by `Tracer` in lieu
// of a `DatadogAgent` whenever `TracerConfig::report_traces` is `false`.
// `Collector` interface in terms of a no-op. It's used in unit tests.

#include "collector.h"

Expand Down
7 changes: 3 additions & 4 deletions include/datadog/tracer.h
Original file line number Diff line number Diff line change
Expand Up @@ -71,10 +71,9 @@ class Tracer {
const SpanConfig& config);

// Return a span extracted from the specified `reader` (see `extract_span`).
// If there is no span to extract, then return a span that is the root of a
// new trace (see `create_span`). Optionally specify a `config` indicating
// the attributes of the span. If a failure occurs, then return an error.
// Note that the absence of a span to extract is not considered an error.
// If there is no span to extract, or if an error occurs during extraction,
// then return a span that is the root of a new trace (see `create_span`).
// Optionally specify a `config` indicating the attributes of the span.
Span extract_or_create_span(const DictReader& reader);
Span extract_or_create_span(const DictReader& reader,
const SpanConfig& config);
Expand Down
15 changes: 0 additions & 15 deletions src/README.md

This file was deleted.