Digital Twin Graph

README.md

@@ -90,8 +90,7 @@ Instructions for installing Mosquitto can be found [here](https://github.com/ecl
 
 ## <a name="cloning-the-repo">Cloning the Repo</a>
 
-The repo has two submodules [opendigitaltwins-dtdl](https://github.com/Azure/opendigitaltwins-dtdl) and [iot-plugandplay-models](https://github.com/Azure/iot-plugandplay-models) that provide DTDL context files
-and DTDL samples file. To ensure that these are included, please use the following command when cloning Ibeji's github repo:
+The repo has two submodules [opendigitaltwins-dtdl](https://github.com/Azure/opendigitaltwins-dtdl) and [iot-plugandplay-models](https://github.com/Azure/iot-plugandplay-models) that provide DTDL context files and DTDL samples file. To ensure that these are included, please use the following command when cloning Ibeji's github repo:
 
 ````shell
 git clone --recurse-submodules https://github.com/eclipse-ibeji/ibeji`
@@ -107,8 +106,7 @@ cargo build
 
 This will build all of the foundation libraries and executables.
 
-Ibeji also has add-on modules that rely on feature flags to include them in the build. For example, to build Ibeji with the Digital Twin Graph
-and the Digital Twin Registry modules run:
+Ibeji also has add-on modules that rely on feature flags to include them in the build. For example, to build Ibeji with the Digital Twin Graph and the Digital Twin Registry modules run:
 
 ````shell
 cargo build --features "digital_twin_graph,digital_twin_registry"

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()
 }