Skip to content

Commit a13adf9

Browse files
committed
docs: correct documentation regarding bare url use and broken links
1 parent 27596f0 commit a13adf9

File tree

4 files changed

+8
-8
lines changed

4 files changed

+8
-8
lines changed

post-compute/src/api/result_proxy_api_client.rs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -56,7 +56,7 @@ impl ResultProxyApiClient {
5656
///
5757
/// # Arguments
5858
///
59-
/// * `base_url` - The base URL of the result proxy service (e.g., "https://result.v8-bellecour.iex.ec")
59+
/// * `base_url` - The base URL of the result proxy service (e.g., "<https://result.v8-bellecour.iex.ec>")
6060
///
6161
/// # Returns
6262
///

post-compute/src/api/worker_api.rs

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -42,8 +42,8 @@ impl<'a> From<&'a ReplicateStatusCause> for ExitMessage<'a> {
4242

4343
/// Thin wrapper around a [`Client`] that knows how to reach the iExec worker API.
4444
///
45-
/// This client can be created directly with a base URL using [`new()`], or
46-
/// configured from environment variables using [`from_env()`].
45+
/// This client can be created directly with a base URL using [`WorkerApiClient::new`], or
46+
/// configured from environment variables using [`WorkerApiClient::from_env`].
4747
///
4848
/// # Example
4949
///
@@ -69,7 +69,7 @@ impl WorkerApiClient {
6969

7070
/// Creates a new WorkerApiClient instance with configuration from environment variables.
7171
///
72-
/// This method retrieves the worker host from the [`WORKER_HOST_ENV_VAR`] environment variable.
72+
/// This method retrieves the worker host from the [`TeeSessionEnvironmentVariable::WorkerHostEnvVar`] environment variable.
7373
/// If the variable is not set or empty, it defaults to `"worker:13100"`.
7474
///
7575
/// # Returns
@@ -108,11 +108,11 @@ impl WorkerApiClient {
108108
/// # Returns
109109
///
110110
/// * `Ok(())` - If the exit cause was successfully reported
111-
/// * `Err(Error)` - If the exit cause could not be reported due to an HTTP error
111+
/// * `Err(ReplicateStatusCause)` - If the exit cause could not be reported due to an HTTP error
112112
///
113113
/// # Errors
114114
///
115-
/// This function will return an [`Error`] if the request could not be sent or
115+
/// This function will return an [`crate::compute::errors::ReplicateStatusCause`] if the request could not be sent or
116116
/// the server responded with a non‑success status.
117117
///
118118
/// # Example

post-compute/src/compute/app_runner.rs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -43,7 +43,7 @@ pub trait PostComputeRunnerInterface {
4343
/// Production implementation of [`PostComputeRunnerInterface`]
4444
///
4545
/// This struct provides a concrete implementation of the [`PostComputeRunnerInterface`],
46-
/// using the [`signer`] module for challenge generation and the owned [`WorkerApiClient`]
46+
/// using the [`super::signer`] module for challenge generation and the owned [`WorkerApiClient`]
4747
/// instance for error reporting.
4848
pub struct DefaultPostComputeRunner {
4949
worker_api_client: WorkerApiClient,

post-compute/src/compute/web2_result.rs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@ const DROPBOX_RESULT_STORAGE_PROVIDER: &str = "dropbox";
3131
///
3232
/// The trait methods represent the main stages of the result processing workflow:
3333
/// validation, compression, and upload. Each method can be used independently or
34-
/// as part of the complete workflow provided by [`encrypt_and_upload_result`].
34+
/// as part of the complete workflow provided by [`Web2ResultInterface::encrypt_and_upload_result`].
3535
///
3636
///
3737
/// # Example Implementation

0 commit comments

Comments
 (0)