Digital Twin Graph

Author: ashbeitz

core/common/src/utils.rs

@@ -42,8 +42,6 @@ pub enum ServiceUriSource {
 ///
 /// # Arguments
 /// * `config_filename` - Name of the config file to load settings from.
-/// # Returns
-/// * The settings.
 pub fn load_settings<T>(config_filename: &str) -> Result<T, ConfigError>
 where
     T: for<'de> serde::Deserialize<'de>,
@@ -67,8 +65,6 @@ where
 /// * `retry_interval_ms` - The retry interval between retries in milliseconds.
 /// * `function` - The function to retry.
 /// * `context` - Context field to provide additional info for logging.
-/// # Returns
-/// * The result of the function.
 pub async fn execute_with_retry<T, E, Fut, F: FnMut() -> Fut>(
     max_retries: u32,
     retry_interval_ms: Duration,
@@ -112,8 +108,6 @@ where
 /// * `version` - The service's version.
 /// # `expected_communication_kind` - The service's expected communication kind.
 /// # `expected_communication_reference` - The service's expected communication reference.
-/// # Returns
-/// * The service's URI.
 pub async fn discover_service_using_chariott(
     chariott_uri: &str,
     namespace: &str,
@@ -153,8 +147,6 @@ pub async fn discover_service_using_chariott(
 /// * `service_uri_source` - Enum providing information on how to get the service URI.
 /// # `expected_communication_kind` - The service's expected communication kind.
 /// # `expected_communication_reference` - The service's expected communication reference.
-/// # Returns
-/// * The service's URI.
 pub async fn get_service_uri(
     service_uri_source: ServiceUriSource,
     expected_communication_kind: &str,
@@ -198,8 +190,6 @@ pub async fn get_service_uri(
 /// # Arguments
 /// * `subset` - The provided subset.
 /// * `superset` - The provided superset.
-/// # Returns
-/// * `true` if the subset is a subset of the superset, `false` otherwise.
 pub fn is_subset(subset: &[String], superset: &[String]) -> bool {
     subset.iter().all(|subset_member| {
         superset.iter().any(|supserset_member| subset_member == supserset_member)

core/module/digital_twin_graph/src/digital_twin_graph_config.rs

@@ -16,9 +16,6 @@ pub struct Settings {
 
 /// Load the settings.
 /// The settings are loaded from the default config file name.
-///
-/// # Returns
-/// The settings.
 pub fn load_settings() -> Settings {
     utils::load_settings(DEFAULT_CONFIG_FILENAME).unwrap()
 }
@@ -27,8 +24,6 @@ pub fn load_settings() -> Settings {
 ///
 /// # Arguments
 /// * `config_filename` - The name of the config file.
-/// # Returns
-/// The settings.
 pub fn load_settings_with_config_filename(config_filename: &str) -> Settings {
     utils::load_settings(config_filename).unwrap()
 }

core/module/digital_twin_graph/src/digital_twin_graph_impl.rs

@@ -52,8 +52,6 @@ impl DigitalTwinGraphImpl {
     /// * `digital_twin_registry_uri` - The uri for the digital twin registry service.
     /// * `respond_uri` - The uri for the respond service.
     /// * `tx` - The sender for the asynchronous channel for AnswerRequest's.
-    /// # Returns
-    /// A new instance of a DigitalTwinGraphImpl.
     pub fn new(
         digital_twin_registry_uri: &str,
         respond_uri: &str,
@@ -73,8 +71,6 @@ impl DigitalTwinGraphImpl {
     /// * `model_id` - The matching model id.
     /// * `protocol` - The required protocol.
     /// * `operations` - The required operations.
-    /// # Returns
-    /// A list of endpoint infos.
     pub async fn find_digital_twin_providers_with_model_id(
         &self,
         model_id: &str,
@@ -118,8 +114,6 @@ impl DigitalTwinGraphImpl {
     /// * `instance_id` - The matching instance id.
     /// * `protocol` - The required protocol.
     /// * `operations` - The required operations.
-    /// # Returns
-    /// A list of endpoint infos.
     pub async fn find_digital_twin_providers_with_instance_id(
         &self,
         instance_id: &str,
@@ -165,8 +159,6 @@ impl DigitalTwinGraph for DigitalTwinGraphImpl {
     ///
     /// # Arguments
     /// * `request` - Find request.
-    /// # Returns
-    /// Find response.
     async fn find(
         &self,
         request: tonic::Request<FindRequest>,
@@ -296,8 +288,6 @@ impl DigitalTwinGraph for DigitalTwinGraphImpl {
     ///
     /// # Arguments
     /// * `request` - Get request.
-    /// # Returns
-    /// Get response.
     async fn get(
         &self,
         request: tonic::Request<GetRequest>,
@@ -406,8 +396,6 @@ impl DigitalTwinGraph for DigitalTwinGraphImpl {
     ///
     /// # Arguments
     /// * `request` - Set request.
-    /// # Returns
-    /// Set response.
     async fn set(
         &self,
         request: tonic::Request<SetRequest>,
@@ -421,8 +409,6 @@ impl DigitalTwinGraph for DigitalTwinGraphImpl {
     ///
     /// # Arguments
     /// * `request` - Invoke request.
-    /// # Returns
-    /// Invoke response.
     async fn invoke(
         &self,
         request: tonic::Request<InvokeRequest>,

docs/design/modules/digital_twin_graph/README.md

@@ -6,7 +6,7 @@
 
 ## <a name="introduction">Introduction</a>
 
-The initial Ibeji provided the foundations for constructing and interacting with a digital twin on an edge device. These foundations are low-level abilities
+The initial Ibeji implementation provided the foundations for constructing and interacting with a digital twin on an edge device. These foundations are low-level abilities
 and they do not necessarily provide a consumer with the best interaction experience. However, they can be used as building blocks to build facades that
 provide a consumer with an abstraction that delivers a much better interaction experience. Ibeji may support multiple facades and the user can select the one
 that they prefer to use.