Skip to content

Commit 7f6fdbf

Browse files
committed
Added missing parameter. Removed double "the".
1 parent 6cfa4dd commit 7f6fdbf

File tree

10 files changed

+15
-14
lines changed

10 files changed

+15
-14
lines changed

api/swimos_agent_protocol/src/model.rs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -156,7 +156,7 @@ pub struct AdHocCommand<S, T> {
156156

157157
impl<S, T> AdHocCommand<S, T> {
158158
/// # Arguments
159-
/// * `address` - The target lane for the the command.
159+
/// * `address` - The target lane for the command.
160160
/// * `command` - The body of the command message.
161161
/// * `overwrite_permitted` - Controls the behaviour of command handling in the case of back-pressure.
162162
/// If this is true, the command maybe be overwritten by a subsequent command to the same target (and so

api/swimos_form/src/lib.rs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@
2020
//! [`std::collections::HashMap`].
2121
//!
2222
//! A derivation macro is provided that can automatically generate implementations for straightforward
23-
//! struct and enum types. For instructions on how to use this, see the the [`Form`] trait or the SwimOS
23+
//! struct and enum types. For instructions on how to use this, see the [`Form`] trait or the SwimOS
2424
//! documentation.
2525
2626
#![allow(clippy::match_wild_err_arm)]

api/swimos_form/src/structural/generic/coproduct.rs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -45,7 +45,7 @@ impl Coproduct for CNil {
4545
}
4646

4747
/// A non-empty coproduct. In general, we should have `T: Coproduct`, however, this makes it
48-
/// impossible to implement traits for general co-products due the the potentially unbounded
48+
/// impossible to implement traits for general co-products due potentially unbounded
4949
/// recursion.
5050
pub enum CCons<H, T> {
5151
Head(H),

api/swimos_form/src/structural/generic/header.rs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -139,7 +139,7 @@ impl<T, S: AppendHeaders> HeaderWithBody<T, S> {
139139
}
140140

141141
/// This trait allows all of the types in this crate to be used with a unified interface
142-
/// in the the macro-derived implementations.
142+
/// in the macro-derived implementations.
143143
pub trait AppendHeaders {
144144
/// The number of items that will be written into the attribute body.
145145
fn num_items(&self) -> usize;

api/swimos_model/src/value.rs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -191,7 +191,7 @@ impl Display for ValueKind {
191191
}
192192

193193
impl Value {
194-
/// Checks if the a [`Value`] is coercible into the [`ValueKind`] provided.
194+
/// Checks if the [`Value`] is coercible into the [`ValueKind`] provided.
195195
pub fn is_coercible_to(&self, kind: ValueKind) -> bool {
196196
match &self {
197197
Value::Int32Value(n) => match &kind {

docs/downlink.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ The common events shared by all downlinks are:
2424
2. `on_synced`: This is triggered when a consistent view of the state of the remote lane has been assembled in the
2525
downlink. It takes a reference to the state of the downlink as a parameter.
2626
3. `on_unlinked`: This is triggered when the link to the remote lane is closed. It takes no parameters.
27-
4. `on_failed`: This is triggered when the link the the remote lane fails with an error. It takes no parameters.
27+
4. `on_failed`: This is triggered when the link the remote lane fails with an error. It takes no parameters.
2828

2929
As downlinks have a single type (whereas an agent can have multiple lanes with arbitrary types) it is not necessary to
3030
use a macro to assemble a downlink lifecycle implementation. Instead, builder types are provided to specify the event
@@ -149,7 +149,7 @@ Each time a value is received on the downlink, it will be set as the value of th
149149
Building a stateful downlink
150150
----------------------------
151151

152-
As with agent lifecycles, it is possible to add state the a downlink lifecycle. As an example, we can extend the
152+
As with agent lifecycles, it is possible to add state to a downlink lifecycle. As an example, we can extend the
153153
downlink lifecycle from the previous section to set the value of the `received` lane to be the _previous_ value that was
154154
received by the downlink.
155155

runtime/swimos_runtime/src/agent/mod.rs

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -60,7 +60,7 @@ use self::{
6060
},
6161
};
6262

63-
/// Describes the metrics the the agent runtime task reports as it runs. These are subscribed to by the
63+
/// Describes the metrics the agent runtime task reports as it runs. These are subscribed to by the
6464
/// introspection API to report on the internal state of server application.
6565
pub mod reporting;
6666
mod store;
@@ -137,6 +137,7 @@ impl DownlinkRequest {
137137
/// # Arguments
138138
///
139139
/// * `remote` - An explicit host for the agent, if defined.
140+
/// * `address` - The containing node URI a and name of the lane to link to.
140141
/// * `kind` - The kind of the downlink to open.
141142
/// * `options` - Configuration parameters for the downlink.
142143
/// * `promise` - A promise to be satisfied with a channel to the downlink.
@@ -597,7 +598,7 @@ impl AgentRouteChannels {
597598
}
598599
}
599600

600-
/// The agent runtime task. This mediates between the the user defined agent state and event handlers
601+
/// The agent runtime task. This mediates between the user defined agent state and event handlers
601602
/// and the other entities within the Swim server application.
602603
pub struct AgentRouteTask<'a, A> {
603604
agent: &'a A,

runtime/swimos_runtime/src/lib.rs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@
1616
//!
1717
//! Tokio tasks describing the core IO loops for agents and downlinks. These tasks implement
1818
//! the Warp protocol only and are entirely decoupled from the state and user defined behaviour
19-
//! of the the agents/downlinks.
19+
//! of the agents/downlinks.
2020
2121
use swimos_utilities::byte_channel::{ByteReader, ByteWriter};
2222

server/swimos_agent_derive/src/lane_model_derive/model.rs

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -183,7 +183,7 @@ bitflags! {
183183
}
184184
}
185185

186-
/// Description of an item (its name the the kind of the item, along with types).
186+
/// Description of an item (its name the kind of the item, along with types).
187187
#[derive(Clone)]
188188
pub struct ItemModel<'a> {
189189
pub name: &'a Ident,
@@ -227,7 +227,7 @@ impl<'a> ItemModel<'a> {
227227
}
228228
}
229229

230-
/// Description of an lane (its name the the kind of the lane, along with types).
230+
/// Description of an lane (its name the kind of the lane, along with types).
231231
#[derive(Clone)]
232232
pub struct WarpLaneModel<'a> {
233233
pub name: &'a Ident,
@@ -236,7 +236,7 @@ pub struct WarpLaneModel<'a> {
236236
pub transform: NameTransform,
237237
}
238238

239-
/// Description of an HTTP lane (its name the the kind of the lane, along with types).
239+
/// Description of an HTTP lane (its name the kind of the lane, along with types).
240240
#[derive(Clone)]
241241
pub struct HttpLaneModel<'a> {
242242
pub name: &'a Ident,

swimos/src/agent.rs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -156,7 +156,7 @@ pub use swimos_agent_derive::{lifecycle, projections, AgentLaneModel};
156156
/// For [`crate::agent::lanes::HttpLane`], the constraints on the type parameters are determined by the
157157
/// codec that is selected for the lane (using the appropriate type parameter). By default, this is the
158158
/// [`crate::agent::lanes::http::DefaultCodec`]. This codec always requires that type parameters implement
159-
/// [`crate::form::Form`] and, if the 'json' feature is active, that the they are Serde serializable.
159+
/// [`crate::form::Form`] and, if the 'json' feature is active, that they are Serde serializable.
160160
///
161161
/// The supported store types are:
162162
///

0 commit comments

Comments
 (0)