Skip to content
This repository was archived by the owner on Sep 1, 2021. It is now read-only.

Commit d4a1964

Browse files
committed
Fix a few formatting things in the README
1 parent 9ef4ce6 commit d4a1964

File tree

1 file changed

+9
-5
lines changed

1 file changed

+9
-5
lines changed

README.md

Lines changed: 9 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -54,10 +54,14 @@ The client can be configured to use a managed deploy by adjusting the `base_endp
5454

5555
```python
5656
>>> from swiftype_app_search import Client
57-
>>> client = Client(api_key='private-mu75psc5egt9ppzuycnc2mc3', base_endpoint='localhost:3002/api/as/v1', use_https=False)
57+
>>> client = Client(
58+
api_key='private-mu75psc5egt9ppzuycnc2mc3',
59+
base_endpoint='localhost:3002/api/as/v1',
60+
use_https=False
61+
)
5862
```
5963

60-
### Index multiple document
64+
### Indexing: Creating or Updating a Single Document
6165

6266
```python
6367
>>> engine_name = 'favorite-videos'
@@ -71,7 +75,7 @@ The client can be configured to use a managed deploy by adjusting the `base_endp
7175
{'id': 'INscMGmhmX4'}
7276
```
7377

74-
### Index documents
78+
### Indexing: Creating or Updating Multiple Documents
7579

7680
```python
7781
>>> engine_name = 'favorite-videos'
@@ -179,7 +183,7 @@ The client can be configured to use a managed deploy by adjusting the `base_endp
179183
{'deleted': True}
180184
```
181185

182-
### Running search
186+
### Searching
183187

184188
```python
185189
>>> client.search('favorite-videos', 'grumpy cat', {})
@@ -253,7 +257,7 @@ You can checkout the [Elastic App Search community discuss forums](https://discu
253257

254258
## Contribute 🚀
255259

256-
We welcome contributors to the project. Before you begin, a couple notes...
260+
We welcome contributors to the project. Before you begin, a couple notes:
257261

258262
+ Prior to opening a pull request, please create an issue to [discuss the scope of your proposal](https://github.com/swiftype/swiftype-app-search-python/issues).
259263
+ Please write simple code and concise documentation, when appropriate.

0 commit comments

Comments
 (0)