fix: all doc warnings - #2289
Open
Eldolfin wants to merge 4 commits into
Open
Conversation
github-actions
Bot
added
mini-agent
sidecar
common
data-pipeline
crashtracker
sampling
labels
Contributor
🔒 Cargo Deny Results📦
|
Contributor
📚 Documentation Check Results📦
|
🎉 All green!🧪 All tests passed 🎯 Code Coverage (details) 🔗 Commit SHA: fa3f87c | Docs | Datadog PR Page | Give us feedback! |
VianneyRuhlmann
approved these changes
Jul 28, 2026
Contributor
Author
|
@codex review |
BenchmarksComparisonBenchmark execution time: 2026-07-28 18:14:26 Comparing candidate commit fa3f87c in PR branch Found 1 performance improvements and 1 performance regressions! Performance is the same for 121 metrics, 10 unstable metrics.
|
![chatgpt-codex-connector[bot]](https://avatars.githubusercontent.com/in/1144995?s=60&v=4){kind=small}
There was a problem hiding this comment.
💡 Codex Review
Here are some automated review suggestions for this pull request.
Reviewed commit: ddb77d06d5
ℹ️ About Codex in GitHub
Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you
- Open a pull request for review
- Mark a draft as ready
- Comment "@codex review".
If Codex has suggestions, it will comment; otherwise it will react with 👍.
Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".
Eldolfin
commented
Jul 28, 2026
Contributor
Author
There was a problem hiding this comment.
Not sure if changing this file is fine, I don't know where it's used.
Contributor
There was a problem hiding this comment.
Right, also, it's much likely not a cargo doc warning, is it?
Contributor
Author
There was a problem hiding this comment.
It's related to the lint fixes in libdd-crashtracker/src/crash_info/sig_info.rs, because this schema is generated from the structs there and there is a test checking that they are kept in sync (see https://github.com/DataDog/libdatadog/actions/runs/30380720170/job/90347950170?pr=2289#step:10:3643)
Contributor
Artifact Size Benchmark Reportaarch64-alpine-linux-musl
aarch64-unknown-linux-gnu
libdatadog-x64-windows
libdatadog-x86-windows
x86_64-alpine-linux-musl
x86_64-unknown-linux-gnu
|
Eldolfin
marked this pull request as ready for review
July 29, 2026 11:03
![datadog-datadog-prod-us1-2[bot]](https://avatars.githubusercontent.com/u/365230?s=60&v=4){kind=small}
There was a problem hiding this comment.
More details
The PR only changes rustdoc prose, links, and code-fence markup; the referenced API corrections resolve to existing symbols, and no runtime behavior or wire format changes are present. No additional tests recommended: the available cargo documentation and package checks were blocked by the unavailable Rust toolchain download and uncached proptest git dependency.
🤖 Datadog Autotest · Commit fa3f87c · What is Autotest? · @DataDog review to ask questions · Any feedback? Reach out in #autotest
yannham
reviewed
Jul 29, 2026
yannham
left a comment
yannham
left a comment
Contributor
There was a problem hiding this comment.
I've flagged a bunch of links that have been removed. I'm not sure why: is it because of features? Or visibility? In any case I wonder if there's a way to keep them. Links are machine checked by cargo doc, which is a powerful tool against configuration drift...
| /// Set the request timeout. | ||
| /// | ||
| /// Defaults to [`DEFAULT_TIMEOUT_MS`] (2 000 ms) when not set. | ||
| /// Defaults to `DEFAULT_TIMEOUT_MS` (2 000 ms) when not set. |
| /// `Datadog-Meta-Lang-Interpreter`, `Datadog-Meta-Tracer-Version`) from the [`LanguageMetadata`] | ||
| /// supplied when creating the client. | ||
| /// - `User-Agent` derived from [`LanguageMetadata::user_agent`]. | ||
| /// - `User-Agent` derived from `LanguageMetadata::user_agent`. |
| //! | ||
| //! By default this module re-exports from the full [`regex`] crate. | ||
| //! Enable the **`regex-lite`** feature to switch to [`regex_lite`] instead, | ||
| //! Enable the **`regex-lite`** feature to switch to `regex_lite` instead, |
| /// Sets a shared runtime for the TraceExporter to use for background workers. | ||
| /// | ||
| /// `handle` must have been initialized with [`ddog_shared_runtime_new`]. | ||
| /// `handle` must have been initialized with `ddog_shared_runtime_new`. |
| /// The config holds a clone of the `Arc` (increments the strong count), so the | ||
| /// original handle remains valid and must still be freed with | ||
| /// [`ddog_shared_runtime_free`]. | ||
| /// `ddog_shared_runtime_free`. |
| /// | ||
| /// `T` is the string representation: | ||
| /// * `&'a str` — borrowed references used in [`BorrowedAggregationKey`] | ||
| /// * `&'a str` — borrowed references used in `BorrowedAggregationKey` |
| /// Each time bucket holds at most `max_entries_per_bucket` distinct aggregation keys. Once that | ||
| /// limit is reached, spans whose key is not already present are merged into a single overflow | ||
| /// bucket keyed by [`aggregation::TRACER_BLOCKED_VALUE`]. | ||
| /// bucket keyed by `aggregation::TRACER_BLOCKED_VALUE`. |
| /// The output is byte-compatible with [`to_vec_from_v04`] for equivalent data — chunk-level fields | ||
| /// are propagated to every span and typed attributes are bucketed into the v0.4 `meta` / | ||
| /// `metrics` / `meta_struct` maps per [`span_v1`]'s mapping table. | ||
| /// `metrics` / `meta_struct` maps per `span_v1`'s mapping table. |
|
|
||
| /// Type discriminants for attribute values. | ||
| /// An attribute value is encoded as [type_uint8][actual_value]. | ||
| /// An attribute value is encoded as `[type_uint8][actual_value]`. |
Contributor
There was a problem hiding this comment.
Link removal? But also, I think we should remove the [actual_value] link if we just want to get rid of it?
| //! | ||
| //! Builds and runs FFI examples to verify they compile and work correctly. | ||
| //! Usage: cargo ffi-test [--skip-build] [--filter <pattern>] [--keep-artifacts] | ||
| //! Usage: cargo ffi-test [--skip-build] [--filter `<pattern>`] [--keep-artifacts] |
Contributor
There was a problem hiding this comment.
Suggested change
| //! Usage: cargo ffi-test [--skip-build] [--filter `<pattern>`] [--keep-artifacts] | |
| //! Usage: `cargo ffi-test [--skip-build] [--filter <pattern>] [--keep-artifacts]` |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
What does this PR do?
Fix all rustdoc warnings shown when running
cargo docin the repo root.Motivation
Make the public docs easier to read and navigate. For example:
(the links to AgentInfo were broken)
Additional Notes
Anything else we should know when reviewing?
How to test the change?
Running
cargo doc, before some links where either invisible when treated as html tags, or didn't properly link.