Skip to content

Commit cfde760

Browse files
committed
docs: fix broken intra-doc links in builder, context, task docs
Reference-style link definitions ([label]: path) are scoped to the single doc comment they appear in. Uses on separate field/method docs could not see the definitions, leaving unresolved links that failed the cargo doc -D warnings gate with exit code 101. Replace with inline [text](path) links so each doc comment resolves independently. Affects: - reloaded-code-bubblewrap: default_env/extra_env field docs - reloaded-code-core: context::GIT_WORKFLOW - reloaded-code-serdesai: agent_runtime::task sandbox builder docs Verified: cargo doc -D warnings passes for all crates across async/blocking and linux-bubblewrap feature matrixes.
1 parent b69f33c commit cfde760

3 files changed

Lines changed: 6 additions & 9 deletions

File tree

  • src
    • reloaded-code-bubblewrap/src/profile
    • reloaded-code-core/src/context
    • reloaded-code-serdesai/src/agent_runtime

‎src/reloaded-code-bubblewrap/src/profile/builder.rs‎

Lines changed: 3 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -106,14 +106,11 @@ pub struct Builder {
106106
pub(crate) read_only_host_rootfs: bool,
107107
/// Controls whether the sandbox has network access.
108108
pub(crate) network_policy: NetworkPolicy,
109-
/// When `true`, inherited env vars are cleared before applying [`default_env`] and [`extra_env`].
110-
///
111-
/// [`default_env`]: Self::default_env
112-
/// [`extra_env`]: Self::extra_env
109+
/// When `true`, inherited env vars are cleared before applying [`default_env`](Self::default_env) and [`extra_env`](Self::extra_env).
113110
pub(crate) clear_env: bool,
114-
/// Env vars always set (applied before [`extra_env`]).
111+
/// Env vars always set (applied before [`extra_env`](Self::extra_env)).
115112
pub(crate) default_env: Arc<[EnvVar]>,
116-
/// Additional env vars set on top of [`default_env`].
113+
/// Additional env vars set on top of [`default_env`](Self::default_env).
117114
pub(crate) extra_env: Arc<[EnvVar]>,
118115
/// Tracks whether `bwrap` is usable (checked during [`build`](Self::build)).
119116
pub(crate) availability: Availability,

‎src/reloaded-code-core/src/context/mod.rs‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -52,7 +52,7 @@ pub const GITHUB_CLI: &str = include_str!("github_cli.txt");
5252
/// Git workflow context - commit creation guidance.
5353
///
5454
/// Supplemental context for agents using git via the `bash` tool.
55-
/// Include via [`SystemPromptBuilder::add_context`].
55+
/// Include via [`SystemPromptBuilder::add_context`](crate::SystemPromptBuilder::add_context).
5656
pub const GIT_WORKFLOW: &str = include_str!("git_workflow.txt");
5757

5858
/// Trait for tools that provide guidance for system prompts.

‎src/reloaded-code-serdesai/src/agent_runtime/task.rs‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -96,7 +96,7 @@ where
9696
/// - `model_catalog`: Available models for agent resolution.
9797
/// - `credentials`: Credential lookup used to authenticate model requests.
9898
/// - `workspace_root`: Project directory exposed to tools.
99-
/// - `profile`: Pre-built sandbox profile for [`BashTool`].
99+
/// - `profile`: Pre-built sandbox profile for [`BashTool`](crate::BashTool).
100100
/// - `sandbox_tmpdir`: Optional owning temp directories that keep the
101101
/// profile's backing storage alive for the context's lifetime.
102102
///
@@ -260,7 +260,7 @@ where
260260
/// - `model_catalog`: Available models for agent resolution.
261261
/// - `credentials`: Credential lookup used to authenticate model requests.
262262
/// - `workspace_root`: Project directory exposed to tools.
263-
/// - `bash_sandbox`: Pre-built sandbox profile for [`BashTool`].
263+
/// - `bash_sandbox`: Pre-built sandbox profile for [`BashTool`](crate::BashTool).
264264
/// - `_sandbox_tmpdir`: Optional owning temp directories that keep the
265265
/// profile's backing storage alive.
266266
#[cfg(all(feature = "linux-bubblewrap", target_os = "linux"))]

0 commit comments

Comments
 (0)