Skip to content

Commit cb170cd

Browse files
authored
Merge pull request #278 from silvia-odwyer/docs-updates
Grammatical and spelling updates to the documentation.
2 parents ee4035a + a76a4f9 commit cb170cd

2 files changed

Lines changed: 8 additions & 8 deletions

File tree

docs/CONTRIBUTING.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -58,13 +58,13 @@ The static files (`html`, `js`, and `css`) are generated by `yarn`, embedded in
5858

5959
# API
6060

61-
The backend API is documented in the [rest API guide](rest-api.md)
61+
The backend API is documented in the [Rest API guide](rest-api.md)
6262

6363
# Development
6464

6565
Each one of the following sections describes an alternative method to run the project from sources. You may use the one that suits your needs.
6666

67-
They all require the project is cloned into your `$GOPATH`.
67+
They all require that the project is cloned into your `$GOPATH`.
6868

6969
```bash
7070
$ go get -d -u github.com/src-d/gitbase-web/...
@@ -83,7 +83,7 @@ This will start a server locally, which you can access at [http://localhost:8080
8383

8484
## Run Using webpack Hot Module Replacement
8585

86-
Instead of rebuilding the frontend and restarting the backend every time you do a change, you may instead run the backend to provide the API, and use webpack to serve the frontend.
86+
Instead of rebuilding the frontend and restarting the backend every time you make a change, you may instead run the backend to provide the API, and use webpack to serve the frontend.
8787

8888
In one terminal run the Go backend:
8989

docs/rest-api.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -41,7 +41,7 @@ Receives an SQL query and forwards it to the `gitbase` server.
4141

4242
The request body can have:
4343

44-
* `query`: An SQL statement string. Do not include `LIMIT` here.
44+
* `query`: A SQL statement string. Do not include `LIMIT` here.
4545
* `limit`: Number, will be added as SQL `LIMIT` to the query. Optional. Will also be ignored if it is 0.
4646

4747
The success response will contain:
@@ -109,7 +109,7 @@ curl -X POST \
109109
}
110110
```
111111

112-
A failure:
112+
A failure response:
113113

114114
```bash
115115
curl -X POST \
@@ -134,7 +134,7 @@ curl -X POST \
134134
}
135135
```
136136

137-
For a query with uast nodes the protobuf response is unmarshalled and the json is returned:
137+
For a query with UAST nodes, the protobuf response is unmarshalled and the JSON is returned:
138138

139139
```bash
140140
curl -X POST \
@@ -245,7 +245,7 @@ curl -X POST \
245245

246246
The endpoint also receives additional parameters:
247247

248-
- `serverUrl` - allows to override bblfsh server url.
248+
- `serverUrl` - allows to override bblfsh server URL.
249249
- `filename` - can be used instead of language. Then the bblfsh server would try to guess the language.
250250
- `filter` - [xpath query](https://doc.bblf.sh/user/uast-querying.html) to filter the results.
251251

@@ -314,7 +314,7 @@ curl -X GET http://localhost:8080/get-languages
314314
## POST /filter
315315

316316
Accepts an array of UAST protobufs encoded using base64 and a UAST filter query.
317-
Returns the filtered UAST JSON as result.
317+
Returns the resulting filtered UAST JSON.
318318

319319
```bash
320320
curl -X POST \

0 commit comments

Comments
 (0)