Skip to content

Commit

Permalink
chore: fix some comments (#2731)
Browse files Browse the repository at this point in the history
## Summary

 fix some comments

## Changes

Provide a bullet list of individual changes. Leave this section out if
change
set is small and obvious from summary.

## Limitations and future improvements

Provide a bullet list or description of known omissions or limitations
of the
solution and/or any ideas for future improvement. Leave section ouf if
not applicable.

## Checklist before requesting a review

- [ ] Is this a breaking change? If it is, be clear in summary.
- [ ] Read through code myself one more time.
- [ ] Make sure any and all `TODO` comments left behind are meant to be
left in.
- [ ] Has reasonable passing test coverage?
- [ ] Updated changelog if applicable.
- [ ] Updated documentation if applicable.

Signed-off-by: riskrole <yuhang@before.tech>
  • Loading branch information
riskrole authored Sep 3, 2024
1 parent b4d9bd3 commit 9e4df84
Show file tree
Hide file tree
Showing 2 changed files with 2 additions and 2 deletions.
2 changes: 1 addition & 1 deletion docs/docs/usage/configuration.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ const streamr = new Streamr({
```

## The Streamr Node config file
The config file, typically located at `.streamr/config/default.json` or `~/.streamrDocker/config/default.json`, as the name indicates, contains the configuration of the Streamr node. The main part of this config is the [`client`](https://github.com/streamr-dev/network/blob/main/packages/client/src/Config.ts) section. The reamining configuration options of the Streamr node (Broker) config can be discovered from the [broker config schema](https://github.com/streamr-dev/network/blob/main/packages/broker/src/config/config.schema.json). For example, Node plugins are configured here.
The config file, typically located at `.streamr/config/default.json` or `~/.streamrDocker/config/default.json`, as the name indicates, contains the configuration of the Streamr node. The main part of this config is the [`client`](https://github.com/streamr-dev/network/blob/main/packages/client/src/Config.ts) section. The remaining configuration options of the Streamr node (Broker) config can be discovered from the [broker config schema](https://github.com/streamr-dev/network/blob/main/packages/broker/src/config/config.schema.json). For example, Node plugins are configured here.

## The Streamr config package
Not to be confused with the internal Streamr package configurations such as the client and broker, the Network configuration contains mainly "Network level" parameters that are sometimes useful to read from, depending on your use case. The Streamr Network and Streamr apps reference an NPM package containing the [Streamr config package](https://www.npmjs.com/package/@streamr/config). The config package helps resolve the network level configuration that contains contract addresses, entry point addresses, etc:
Expand Down
2 changes: 1 addition & 1 deletion docs/docs/usage/streams/what-are-streams.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ Let's say you have a temperature measurement device that publishes the temperatu
| 2019-08-01 11:30:04.122 | 312.64 |
| 2019-08-01 11:30:05.882 | 312.32 |

Your stream would grow over time and you can add more colums/data fields to your timestamp.
Your stream would grow over time and you can add more columns/data fields to your timestamp.

:::tip Good to know:
[Learn more about pub/sub networking](../../help/pub-sub.md)
Expand Down

0 comments on commit 9e4df84

Please sign in to comment.