Fixed dangling links in docs

Author: Lut99

brane-ast/src/dsl.rs

@@ -60,7 +60,7 @@ pub fn dtype_dsl_to_ast(value: brane_dsl::DataType) -> DataType {
 /// Converts from an [executable Datatype](DataType) to the DSL one.
 ///
 /// # Arguments
-/// - `dtype`: The [`DataType`](DataType) to convert.
+/// - `dtype`: The [`DataType`] to convert.
 ///
 /// # Returns
 /// A converted [`brane_dsl::DataType`].

brane-chk/src/apis/reasoner.rs

@@ -32,7 +32,7 @@ use tracing::{Instrument as _, Level, debug, error, span};
 
 
 /***** ERRORS *****/
-/// Defines the errors originating in the [`Reasoner`] API.
+/// Defines the errors originating in the reasoner API.
 #[derive(Debug, Error)]
 pub enum Error {
     #[error("Failed to create the KID resolver")]
@@ -56,7 +56,7 @@ pub enum Error {
 /// Handler for `GET /v2/context` (i.e., retrieving reasoner context).
 ///
 /// Out:
-/// - 200 OK with a [`ContextResponse`] detailling the relevant reasoner information; or
+/// - 200 OK with a [`GetContextResponse`] detailling the relevant reasoner information; or
 /// - 500 INTERNAL SERVER ERROR with a message what went wrong.
 pub fn get_context<R>(State(this): State<Arc<R>>, Extension(auth): Extension<User>) -> impl Send + Future<Output = (StatusCode, String)>
 where

brane-chk/src/reasonerconn.rs

@@ -9,7 +9,7 @@
 //    Yes
 //
 //  Description:
-//!   Defines a wrapper around an [`EFlintJsonReasonerConnector`] that
+//!   Defines a wrapper around an [`EFlintHaskellReasonerConnector`] that
 //!   includes a particular policy interface.
 //
 

brane-chk/src/workflow/compile.rs

@@ -450,7 +450,7 @@ pub fn pc_to_id(wir: &ast::Workflow, pc: ProgramCounter) -> String { format!("{}
 
 
 
-/// Compiles from a Brane [WIR](brane_ast::Workflow) to a policy reasoner [Workflow].
+/// Compiles from a Brane [WIR](ast::Workflow) to a policy reasoner [Workflow].
 ///
 /// # Arguments
 /// - `wf`: The WIR to compile.

brane-chk/src/workflow/eflint.rs

@@ -9,8 +9,7 @@
 //    Yes
 //
 //  Description:
-//!   Implements a compiler from a [`Workflow`] to a series of
-//!   [`efint_json`] [`Phrase`]s.
+//!   Implements a compiler from a [`Workflow`] to a series of eFLINT phrases.
 //
 
 use std::collections::{HashMap, HashSet};
@@ -473,7 +472,7 @@ impl<'w> Visitor<'w> for EFlintCompiler<'w> {
 
 
 /***** LIBRARY FUNCTIONS *****/
-/// Compiles a [`Workflow`] to a series of [`efint_json`] [`Phrase`]s.
+/// Compiles a [`Workflow`] to a series of eFLINT phrases.
 ///
 /// # Arguments
 /// - `wf`: The [`Workflow`] to compile.

brane-chk/src/workflow/preprocess.rs

@@ -220,7 +220,7 @@ pub enum Error {
     UnknownTask { id: usize },
     /// Unknown function given.
     UnknownFunc { id: FunctionId },
-    /// A [`Call`](ast::Edge::Call)-edge was encountered while we didn't know of a function ID on the stack.
+    /// A [`Call`](Edge::Call)-edge was encountered while we didn't know of a function ID on the stack.
     CallingWithoutId { pc: ResolvedProgramCounter },
 }
 impl Display for Error {

brane-cli/src/run.rs

@@ -128,7 +128,7 @@ pub async fn initialize_instance<O: Write, E: Write>(
 /// - `profile`: If given, prints the profile timings to stdout if reported by the remote.
 ///
 /// # Returns
-/// A [`FullValue`] carrying the result of the snippet (or [`FullValue::Void`]), and a [`ProgramCounter`] in case a [`FullValue::Data`] is returned telling us which edge downloaded it.
+/// A [`FullValue`] carrying the result of the snippet (or [`FullValue::Void`]).
 ///
 /// # Errors
 /// This function may error if anything in the whole shebang crashed. This can be things client-side, but also remote-side.

brane-tsk/src/errors.rs

@@ -412,7 +412,7 @@ pub enum AuthorizeError {
     /// The user to authorize does not execute the given task.
     #[error("Authorized user '{}' does not match '{}' user in workflow\n\nWorkflow:\n{:#?}\n", authenticated, who, workflow)]
     AuthorizationUserMismatch { who: String, authenticated: String, workflow: Workflow },
-    /// An edge was referenced to be executed which wasn't an [`Edge::Node`](brane_ast::ast::Edge).
+    /// An edge was referenced to be executed which wasn't an [`Edge::Node`](specifications::wir::Edge).
     #[error("Edge {pc} in workflow is not an Edge::Node but an Edge::{got}")]
     AuthorizationWrongEdge { pc: ProgramCounter, got: String },
     /// An edge index given was out-of-bounds for the given function.

specifications/src/checking.rs

@@ -121,7 +121,7 @@ pub mod deliberation {
 
 
     /***** API BODIES *****/
-    /// Defines the request to send to the [`Server::check_workflow()`] endpoint.
+    /// Defines the request to send to the workflow validation endpoint.
     #[derive(Clone, Debug, Deserialize, Serialize)]
     pub struct CheckWorkflowRequest {
         /// The usecase that refers to the API to consult for state.
@@ -220,7 +220,7 @@ pub mod deliberation {
 
 
 
-    /// Defines the request to send to the [`Server::check_task()`] endpoint.
+    /// Defines the request to send to the task validation endpoint.
     #[derive(Clone, Debug, Deserialize, Serialize)]
     pub struct CheckTaskRequest {
         /// The usecase that refers to the API to consult for state.
@@ -338,7 +338,7 @@ pub mod deliberation {
 
 
 
-    /// Defines the request to send to the [`Server::check_transfer()`] endpoint.
+    /// Defines the request to send to the transfer validation endpoint.
     #[derive(Clone, Debug, Deserialize, Serialize)]
     pub struct CheckTransferRequest {
         /// The usecase that refers to the API to consult for state.

specifications/src/working.rs

@@ -385,7 +385,7 @@ impl JobServiceClient {
     /// - `request`: The [`CheckWorkflowRequest`] to send to the endpoint.
     ///
     /// # Returns
-    /// The [`CheckReply`] the endpoint returns.
+    /// The [`CheckResponse`] the endpoint returns.
     ///
     /// # Errors
     /// This function errors if either we failed to send the request or the endpoint itself failed to process it.
@@ -410,7 +410,7 @@ impl JobServiceClient {
     /// - `request`: The [`CheckTaskRequest`] to send to the endpoint.
     ///
     /// # Returns
-    /// The [`CheckReply`] the endpoint returns.
+    /// The [`CheckResponse`] the endpoint returns.
     ///
     /// # Errors
     /// This function errors if either we failed to send the request or the endpoint itself failed to process it.
@@ -514,7 +514,7 @@ pub trait JobService: 'static + Send + Sync {
     /// - `request`: The ([`tonic::Request`]-wrapped) [`CheckWorkflowRequest`] containing the relevant details.
     ///
     /// # Returns
-    /// A [`CheckReply`] for this request, wrapped in a [`tonic::Response`].
+    /// A [`CheckResponse`] for this request, wrapped in a [`tonic::Response`].
     ///
     /// # Errors
     /// This function may error (i.e., send back a `tonic::Status`) whenever it fails.
@@ -529,7 +529,7 @@ pub trait JobService: 'static + Send + Sync {
     /// - `request`: The ([`tonic::Request`]-wrapped) [`CheckTaskRequest`] containing the relevant details.
     ///
     /// # Returns
-    /// A [`CheckReply`] for this request, wrapped in a [`tonic::Response`].
+    /// A [`CheckResponse`] for this request, wrapped in a [`tonic::Response`].
     ///
     /// # Errors
     /// This function may error (i.e., send back a `tonic::Status`) whenever it fails.