Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix grammatical issues in documentation #1633

Open
wants to merge 3 commits into
base: master
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -54,9 +54,9 @@ Here is a simple checklist to look at when reviewing a PR for a new strategy:

#### Code

- Strategies should always use a `snapshot` to calculate user's voting power. As a result the voting power should not change throughout the proposal duration.
- Strategies should always use a `snapshot` to calculate users voting power. As a result the voting power should not change throughout the proposal duration.
- There should be a maximum of 5 requests, a request can use "fetch" a "subgraphRequest" or "multicall".
- The strategy should not send a request for each voters, this doesn't scale.
- The strategy should not send a request for each voter, this doesn't scale.
- The strategy PR should not add any new dependency.
- The score returned by the strategy should use the same casing for address as on the input, or should return checksum addresses.
- Make sure that voting power of one address does not depend on other addresses.
Expand Down
4 changes: 2 additions & 2 deletions src/strategies/api-v2/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ Voting strategy using a REST API endpoint. Number of votes depends on the return
| `type` | `string` | Type of the API endpoint ( `api-get` or `api-post` or `ipfs` or `json` ) | `api-get` |
| `additionalParams` | `string` | Additional parameters for the API endpoint (optional) | `` |

If you are passing a IPFS url use following format:
If you are passing an IPFS url use following format:

```JSON
{
Expand All @@ -40,7 +40,7 @@ If you are passing a API url use following format: (all voter addresses will be
}
```

If you are passing a API url with POST method use following format:
If you are passing an API url with POST method use following format:

```JSON
{
Expand Down
2 changes: 1 addition & 1 deletion src/strategies/streamr/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

The Streamr Network is a peer-to-peer network for publishing and subscribing to data in real-time. Applications use it for decentralized messaging, for example sharing data across applications or broadcasting real-time state changes to large audiences. The decentralized nature of the system makes the data transport scalable, robust, secure, tamper proof, and censorship resistant.

Operators are the node running "miners" in the Streamr Network. They run Streamr nodes, subscribe to streams, and stake DATA in the Sponsorship contract(s) of those streams. When they subscribe, they help making that stream more robust. In return, they receive DATA tokens from the Sponsorship contract, in proportion to their stake.
Operators are the node running "miners" in the Streamr Network. They run Streamr nodes, subscribe to streams, and stake DATA in the Sponsorship contract(s) of those streams. When they subscribe, they help make that stream more robust. In return, they receive DATA tokens from the Sponsorship contract, in proportion to their stake.

This is why part of the Operators' DATA tokens are staked in Sponsorships (through an Operator contract that they control). Only a small portion of DATA is expected to be in the Streamr Network participants' wallets, the rest is staked or delegated into the Streamr Network.

Expand Down