Merge pull request #191 from paritytech/docs/meaningful-console-log-examples

docs(api): add descriptive labels to console.log in TS examples

Author: pgherveou

rust/crates/truapi/src/api/account.rs

@@ -22,7 +22,7 @@ pub trait Account: Send + Sync {
     /// const status = await firstValueFrom(
     ///   from(truapi.account.connectionStatusSubscribe()),
     /// );
-    /// console.log(status);
+    /// console.log("connection status:", status);
     /// ```
     #[wire(start_id = 18)]
     async fn connection_status_subscribe(
@@ -42,7 +42,7 @@ pub trait Account: Send + Sync {
     ///   },
     /// });
     /// assert(result.isOk(), "getAccount failed:", result);
-    /// console.log(result.value);
+    /// console.log("account retrieved:", result.value);
     /// ```
     #[wire(request_id = 22)]
     async fn get_account(
@@ -63,7 +63,7 @@ pub trait Account: Send + Sync {
     ///   },
     /// });
     /// assert(result.isOk(), "getAccountAlias failed:", result);
-    /// console.log(result.value);
+    /// console.log("account alias:", result.value);
     /// ```
     #[wire(request_id = 24)]
     async fn get_account_alias(
@@ -92,7 +92,7 @@ pub trait Account: Send + Sync {
     ///   context: "0x",
     /// });
     /// assert(result.isOk(), "createAccountProof failed:", result);
-    /// console.log(result.value);
+    /// console.log("account proof created:", result.value);
     /// ```
     #[wire(request_id = 26)]
     async fn create_account_proof(
@@ -108,7 +108,7 @@ pub trait Account: Send + Sync {
     /// ```ts
     /// const result = await truapi.account.getLegacyAccounts();
     /// assert(result.isOk(), "getLegacyAccounts failed:", result);
-    /// console.log(result.value);
+    /// console.log("legacy accounts:", result.value);
     /// ```
     #[wire(request_id = 28)]
     async fn get_legacy_accounts(
@@ -124,7 +124,7 @@ pub trait Account: Send + Sync {
     /// ```ts
     /// const result = await truapi.account.getUserId();
     /// assert(result.isOk(), "getUserId failed:", result);
-    /// console.log(result.value);
+    /// console.log("user id:", result.value);
     /// ```
     #[wire(request_id = 110)]
     async fn get_user_id(
@@ -145,7 +145,7 @@ pub trait Account: Send + Sync {
     ///   reason: "Sign in to vote on Referendum #42",
     /// });
     /// assert(result.isOk(), "requestLogin failed:", result);
-    /// console.log(result.value);
+    /// console.log("login completed:", result.value);
     /// ```
     #[wire(request_id = 112)]
     async fn request_login(

rust/crates/truapi/src/api/chain.rs

@@ -40,7 +40,7 @@ pub trait Chain: Send + Sync {
     ///     }),
     ///   ),
     /// );
-    /// console.log(item);
+    /// console.log("head follow event:", item);
     /// ```
     #[wire(start_id = 76)]
     async fn follow_head_subscribe(
@@ -68,7 +68,7 @@ pub trait Chain: Send + Sync {
     ///   ),
     /// );
     /// assert(result.isOk(), "getHeadHeader failed:", result);
-    /// console.log(result.value);
+    /// console.log("block header:", result.value);
     /// ```
     #[wire(request_id = 80)]
     async fn get_head_header(
@@ -96,7 +96,7 @@ pub trait Chain: Send + Sync {
     ///   ),
     /// );
     /// assert(result.isOk(), "getHeadBody failed:", result);
-    /// console.log(result.value);
+    /// console.log("block body:", result.value);
     /// ```
     #[wire(request_id = 82)]
     async fn get_head_body(
@@ -129,7 +129,7 @@ pub trait Chain: Send + Sync {
     ///   ),
     /// );
     /// assert(result.isOk(), "getHeadStorage failed:", result);
-    /// console.log(result.value);
+    /// console.log("storage value:", result.value);
     /// ```
     #[wire(request_id = 84)]
     async fn get_head_storage(
@@ -164,7 +164,7 @@ pub trait Chain: Send + Sync {
     ///   ),
     /// );
     /// assert(result.isOk(), "callHead failed:", result);
-    /// console.log(result.value);
+    /// console.log("runtime call result:", result.value);
     /// ```
     #[wire(request_id = 86)]
     async fn call_head(
@@ -196,7 +196,7 @@ pub trait Chain: Send + Sync {
     ///   ),
     /// );
     /// assert(result.isOk(), "unpinHead failed:", result);
-    /// console.log("ok");
+    /// console.log("blocks unpinned");
     /// ```
     #[wire(request_id = 88)]
     async fn unpin_head(
@@ -228,7 +228,7 @@ pub trait Chain: Send + Sync {
     ///   ),
     /// );
     /// assert(result.isOk(), "continueHead failed:", result);
-    /// console.log("ok");
+    /// console.log("operation continued");
     /// ```
     #[wire(request_id = 90)]
     async fn continue_head(
@@ -260,7 +260,7 @@ pub trait Chain: Send + Sync {
     ///   ),
     /// );
     /// assert(result.isOk(), "stopHeadOperation failed:", result);
-    /// console.log("ok");
+    /// console.log("operation stopped");
     /// ```
     #[wire(request_id = 92)]
     async fn stop_head_operation(
@@ -281,7 +281,7 @@ pub trait Chain: Send + Sync {
     ///   genesisHash: PASEO_NEXT_V2_ASSET_HUB.genesis,
     /// });
     /// assert(result.isOk(), "getSpecGenesisHash failed:", result);
-    /// console.log(result.value);
+    /// console.log("genesis hash:", result.value);
     /// ```
     #[wire(request_id = 94)]
     async fn get_spec_genesis_hash(
@@ -302,7 +302,7 @@ pub trait Chain: Send + Sync {
     ///   genesisHash: PASEO_NEXT_V2_ASSET_HUB.genesis,
     /// });
     /// assert(result.isOk(), "getSpecChainName failed:", result);
-    /// console.log(result.value);
+    /// console.log("chain name:", result.value);
     /// ```
     #[wire(request_id = 96)]
     async fn get_spec_chain_name(
@@ -322,7 +322,7 @@ pub trait Chain: Send + Sync {
     ///   genesisHash: PASEO_NEXT_V2_ASSET_HUB.genesis,
     /// });
     /// assert(result.isOk(), "getSpecProperties failed:", result);
-    /// console.log(result.value);
+    /// console.log("chain properties:", result.value);
     /// ```
     #[wire(request_id = 98)]
     async fn get_spec_properties(
@@ -343,7 +343,7 @@ pub trait Chain: Send + Sync {
     ///   transaction: "0x",
     /// });
     /// assert(result.isOk(), "broadcastTransaction failed:", result);
-    /// console.log(result.value);
+    /// console.log("transaction broadcast:", result.value);
     /// ```
     #[wire(request_id = 100)]
     async fn broadcast_transaction(
@@ -367,7 +367,7 @@ pub trait Chain: Send + Sync {
     ///   operationId: "op-id",
     /// });
     /// assert(result.isOk(), "stopTransaction failed:", result);
-    /// console.log("ok");
+    /// console.log("transaction broadcast stopped");
     /// ```
     #[wire(request_id = 102)]
     async fn stop_transaction(

rust/crates/truapi/src/api/chat.rs

@@ -21,7 +21,7 @@ pub trait Chat: Send + Sync {
     ///   icon: "",
     /// });
     /// assert(result.isOk(), "createRoom failed:", result);
-    /// console.log(result.value);
+    /// console.log("room created:", result.value);
     /// ```
     #[wire(request_id = 38)]
     async fn create_room(
@@ -41,7 +41,7 @@ pub trait Chat: Send + Sync {
     ///   icon: "",
     /// });
     /// assert(result.isOk(), "registerBot failed:", result);
-    /// console.log(result.value);
+    /// console.log("bot registered:", result.value);
     /// ```
     #[wire(request_id = 40)]
     async fn register_bot(
@@ -60,7 +60,7 @@ pub trait Chat: Send + Sync {
     /// const item = await firstValueFrom(
     ///   from(truapi.chat.listSubscribe()),
     /// );
-    /// console.log(item);
+    /// console.log("room list received:", item);
     /// ```
     #[wire(start_id = 42)]
     async fn list_subscribe(&self, _cx: &CallContext) -> Subscription<HostChatListSubscribeItem> {
@@ -75,7 +75,7 @@ pub trait Chat: Send + Sync {
     ///   payload: { tag: "Text", value: { text: "Hello from playground!" } },
     /// });
     /// assert(result.isOk(), "postMessage failed:", result);
-    /// console.log(result.value);
+    /// console.log("message posted:", result.value);
     /// ```
     #[wire(request_id = 46)]
     async fn post_message(
@@ -94,7 +94,7 @@ pub trait Chat: Send + Sync {
     /// const item = await firstValueFrom(
     ///   from(truapi.chat.actionSubscribe()),
     /// );
-    /// console.log(item);
+    /// console.log("action received:", item);
     /// ```
     #[wire(start_id = 48)]
     async fn action_subscribe(
@@ -122,7 +122,7 @@ pub trait Chat: Send + Sync {
     ///     }),
     ///   ),
     /// );
-    /// console.log(item);
+    /// console.log("render request received:", item);
     /// ```
     #[wire(start_id = 52)]
     async fn custom_message_render_subscribe(

rust/crates/truapi/src/api/coin_payment.rs

@@ -30,7 +30,7 @@ pub trait CoinPayment: Send + Sync {
     ///   name: "Terminal purse",
     /// });
     /// assert(result.isOk(), "createPurse failed:", result);
-    /// console.log(result.value.purse);
+    /// console.log("purse created:", result.value.purse);
     /// ```
     #[wire(request_id = 136)]
     async fn create_purse(
@@ -47,7 +47,7 @@ pub trait CoinPayment: Send + Sync {
     /// ```ts
     /// const result = await truapi.coinPayment.queryPurse({ purse: 1 });
     /// assert(result.isOk(), "queryPurse failed:", result);
-    /// console.log(result.value.info);
+    /// console.log("purse info:", result.value.info);
     /// ```
     #[wire(request_id = 138)]
     async fn query_purse(
@@ -70,7 +70,7 @@ pub trait CoinPayment: Send + Sync {
     ///     }),
     ///   ),
     /// );
-    /// console.log(status);
+    /// console.log("rebalance status:", status);
     /// ```
     #[wire(start_id = 140)]
     async fn rebalance_purse(
@@ -96,7 +96,7 @@ pub trait CoinPayment: Send + Sync {
     ///     }),
     ///   ),
     /// );
-    /// console.log(status);
+    /// console.log("delete status:", status);
     /// ```
     #[wire(start_id = 144)]
     async fn delete_purse(
@@ -115,7 +115,7 @@ pub trait CoinPayment: Send + Sync {
     /// ```ts
     /// const result = await truapi.coinPayment.createReceivable({ into: 1 });
     /// assert(result.isOk(), "createReceivable failed:", result);
-    /// console.log(result.value.receivable);
+    /// console.log("receivable created:", result.value.receivable);
     /// ```
     #[wire(request_id = 148)]
     async fn create_receivable(
@@ -138,7 +138,7 @@ pub trait CoinPayment: Send + Sync {
     ///   amount: 1000,
     /// });
     /// assert(result.isOk(), "createCheque failed:", result);
-    /// console.log(result.value.cheque);
+    /// console.log("cheque created:", result.value.cheque);
     /// ```
     #[wire(request_id = 150)]
     async fn create_cheque(
@@ -165,7 +165,7 @@ pub trait CoinPayment: Send + Sync {
     /// const status = await firstValueFrom(
     ///   from(truapi.coinPayment.deposit({ request: { cheque } })),
     /// );
-    /// console.log(status);
+    /// console.log("deposit status:", status);
     /// ```
     #[wire(start_id = 152)]
     async fn deposit(
@@ -192,7 +192,7 @@ pub trait CoinPayment: Send + Sync {
     ///     }),
     ///   ),
     /// );
-    /// console.log(status);
+    /// console.log("refund status:", status);
     /// ```
     #[wire(start_id = 156)]
     async fn refund(
@@ -219,7 +219,7 @@ pub trait CoinPayment: Send + Sync {
     ///     }),
     ///   ),
     /// );
-    /// console.log(item);
+    /// console.log("payment received:", item);
     /// ```
     #[wire(start_id = 160)]
     async fn listen_for_payment(

rust/crates/truapi/src/api/entropy.rs

@@ -15,7 +15,7 @@ pub trait Entropy: Send + Sync {
     ///   context: "0x70726f647563742d6b6579",
     /// });
     /// assert(result.isOk(), "derive failed:", result);
-    /// console.log(result.value);
+    /// console.log("entropy derived:", result.value);
     /// ```
     #[wire(request_id = 108)]
     async fn derive(

rust/crates/truapi/src/api/local_storage.rs

@@ -15,7 +15,7 @@ pub trait LocalStorage: Send + Sync {
     /// ```ts
     /// const result = await truapi.localStorage.read({ key: "test-key" });
     /// assert(result.isOk(), "read failed:", result);
-    /// console.log(result.value.value);
+    /// console.log("storage value read:", result.value.value);
     /// ```
     #[wire(request_id = 12)]
     async fn read(
@@ -32,7 +32,7 @@ pub trait LocalStorage: Send + Sync {
     ///   value: "0x48656c6c6f",
     /// });
     /// assert(result.isOk(), "write failed:", result);
-    /// console.log("ok");
+    /// console.log("storage write succeeded");
     /// ```
     #[wire(request_id = 14)]
     async fn write(
@@ -46,7 +46,7 @@ pub trait LocalStorage: Send + Sync {
     /// ```ts
     /// const result = await truapi.localStorage.clear({ key: "test-key" });
     /// assert(result.isOk(), "clear failed:", result);
-    /// console.log("ok");
+    /// console.log("storage clear succeeded");
     /// ```
     #[wire(request_id = 16)]
     async fn clear(

rust/crates/truapi/src/api/notifications.rs

@@ -25,7 +25,7 @@ pub trait Notifications: Send + Sync {
     ///   text: "Hello!",
     /// });
     /// assert(result.isOk(), "sendPushNotification failed:", result);
-    /// console.log(result.value);
+    /// console.log("notification sent:", result.value);
     /// ```
     #[wire(request_id = 4)]
     async fn send_push_notification(
@@ -46,7 +46,7 @@ pub trait Notifications: Send + Sync {
     ///   id: 1,
     /// });
     /// assert(result.isOk(), "cancelPushNotification failed:", result);
-    /// console.log("ok");
+    /// console.log("notification cancelled");
     /// ```
     #[wire(request_id = 134)]
     async fn cancel_push_notification(