You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/docs/developing/commit-module.md
+4-4
Original file line number
Diff line number
Diff line change
@@ -4,7 +4,7 @@ sidebar_position: 2
4
4
5
5
# Commit Module
6
6
7
-
While a module can be written in any language, we currently provide some utils for Rust, with the goal of supporting more generalized APIs and simplify development in languages other than Rust.
7
+
While a module can be written in any language, we currently provide some utilities for Rust, with the goal of supporting more generalized APIs and simplify development in languages other than Rust.
8
8
9
9
:::note
10
10
Commit-Boost is still in alpha development, all APIs are subject to change
@@ -25,7 +25,7 @@ use commit_boost::prelude::*;
25
25
## Config
26
26
Your module will likely need a configuration for the Node Operator to customize. This will have to be in the `cb-config.toml` file, in the correct `[[module]]` section. In the module, you can define and load your config as follows.
27
27
28
-
First define all the parameters needed in a struct:
28
+
First, define all the parameters needed in a struct:
29
29
```rust
30
30
#[derive(Debug, Deserialize)]
31
31
structExtraConfig {
@@ -109,7 +109,7 @@ You can use the `prometheus` crate to create a custom registry and metrics, for
@@ -125,4 +125,4 @@ All that is left is to use the metrics throughout your code:
125
125
```rust
126
126
SIG_RECEIVED_COUNTER.inc();
127
127
```
128
-
These will automatically scraped by the Prometheus service running, and exposed on port `9090`. We plan to allow developers to ship pre-made dashboards together with their modules, to allow Node Operators to have an improved oversight on the modules they are running.
128
+
These will be automatically scraped by the Prometheus service running, and exposed on port `9090`. We plan to allow developers to ship pre-made dashboards together with their modules, to allow Node Operators to have an improved oversight on the modules they are running.
0 commit comments