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.

Sign up for GitHub

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

typos and recommendation #9

Merged
merged 1 commit into from
Mar 18, 2021
Merged

typos and recommendation #9

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
6 changes: 3 additions & 3 deletions API.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,8 +8,8 @@

### Properties

- [#app](API.md##app)
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I assume this file is autogenerated. Am I right? So this error will probably popup again.

- [#connector](API.md##connector)
- [#app](API.md#app)
- [#connector](API.md#connector)

### Methods

Expand Down Expand Up @@ -317,7 +317,7 @@ Name | Type | Description |

**Returns:** *SubscriptionHandler*

A function handler use to cancel the
A function handler used to cancel the
subscription at any time.

Defined in: [Hatch.ts:50](https://github.com/TECommons/hatch-connector/blob/main/src/models/Hatch.ts#L50)
Expand Down
2 changes: 1 addition & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

Connector for the Hatch frontend implemented using [Aragon Connect](https://aragon.org/connect). It connects to a [hatch subgraph](https://github.com/TECommons/hatch-connector/tree/main/subgraph) created using [The Graph](https://thegraph.com/) indexing protocol.

The hatch subgraph collects, store and index hatch-related data from the blockchain and serves it through a [GraphQL](https://graphql.org/) endpoint. The connector is an abstraction over this subgraph which offers an API that can be use by any client to fetch data.
The hatch subgraph collects, stores and indexes hatch-related data from the blockchain and serves it through a [GraphQL](https://graphql.org/) endpoint. The connector is an abstraction over this subgraph which offers an API that can be use by any client to fetch data.

## API Reference

Expand Down
2 changes: 1 addition & 1 deletion src/models/Hatch.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,7 @@ class Hatch {
* of the hatch and the hatch oracle.
* @param {SubscriptionCallback<GeneralConfig>} callback A callback function that
* receives the updated general configuration data.
* @returns {SubscriptionHandler} A function handler use to cancel the
* @returns {SubscriptionHandler} A function handler used to cancel the
* subscription at any time.
*/
onGeneralConfig(
Expand Down
5 changes: 2 additions & 3 deletions subgraph/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ Currently there are Subgraphs deployed on the [xdai](https://thegraph.com/explor

## Queries

Below there are a few ways to show how to query the Subgraph for data. The queries show most of the information that is queryable, but there are many other filtering options that can be used, just check out the [querying api](https://thegraph.com/docs/graphql-api). These queries can be used locally or in The Graph Explorer playground.
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is just a recommendation. I hope I got this right.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It's great!

Below there are a few ways to show how to query the Subgraph for data. The queries show most of the information that can be queried. But there are also many filter options that can be used. Just check out the [querying api](https://thegraph.com/docs/graphql-api). These queries can be used locally or in The Graph Explorer playground.

### Querying the Hatch data

Expand Down Expand Up @@ -73,5 +73,4 @@ contributions(first: 10, orderBy: value, orderDirection: desc) {
```


For more information see The Graph [docs](https://thegraph.com/docs/) and the Aragon Connect [docs](https://connect.aragon.org/advanced/app-subgraphs).

For more information see The Graph [docs](https://thegraph.com/docs/) and the Aragon Connect [docs](https://connect.aragon.org/advanced/app-subgraphs).