Skip to content

Commit

Permalink
Fix missing documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
IAvecilla committed Feb 16, 2024
1 parent 85b66d0 commit 6ef448e
Show file tree
Hide file tree
Showing 3 changed files with 5 additions and 0 deletions.
3 changes: 3 additions & 0 deletions node/tests/src/main.rs
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,8 @@ enum TesterCommands {
Run,
}

/// Get the path of the node ips config file.
/// This way we can run the test from every directory and also inside kubernetes pod.
fn get_config_path() -> String {
// This way we can run the test from every directory and also inside kubernetes pod.
let manifest_path = std::env::var("CARGO_MANIFEST_DIR");
Expand All @@ -54,6 +56,7 @@ pub async fn generate_config() {
}
}

/// Start the tests pod in the kubernetes cluster.
pub async fn start_tests_pod() {
let client = k8s::get_client().await.unwrap();
k8s::create_tests_deployment(&client).await.unwrap();
Expand Down
1 change: 1 addition & 0 deletions node/tools/src/config.rs
Original file line number Diff line number Diff line change
Expand Up @@ -34,6 +34,7 @@ pub(crate) fn encode_json<T: serde::ser::Serialize>(x: &T) -> String {
encode_with_serializer(x, s)
}

/// Encodes a generated proto message to json for arbitrary ProtoFmt with a custom serializer.
pub(crate) fn encode_with_serializer<T: serde::ser::Serialize, F: Formatter>(
x: &T,
mut serializer: Serializer<Vec<u8>, F>,
Expand Down
1 change: 1 addition & 0 deletions node/tools/src/rpc/methods/config.rs
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,7 @@ pub(crate) struct ConfigInfo;
// RPCMethod trait should be more general to allow external parameters like this case
// TODO fix the trait and implement this code in it
impl ConfigInfo {
/// Returns the config of the node, this reads the config.json file so does not support live updates.
pub(crate) fn info(config: AppConfig) -> Result<serde_json::Value, ErrorCode> {
// This may change in the future since we are assuming that the executor binary is being run inside the config directory.
Ok(serde_json::json!({
Expand Down

0 comments on commit 6ef448e

Please sign in to comment.