Skip to content

Commit ed0ad1c

Browse files
LAU KENNETHLAU KENNETH
LAU KENNETH
authored and
LAU KENNETH
committed
Fix documentation issues
1 parent e300bdf commit ed0ad1c

File tree

4 files changed

+28
-29
lines changed

4 files changed

+28
-29
lines changed

README.rst

Lines changed: 25 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -5,14 +5,14 @@ line-bot-sdk-python
55

66
SDK of the LINE Messaging API for Python.
77

8-
About LINE Messaging API
8+
About the LINE Messaging API
99
------------------------
1010

11-
Please refer to the official API documents for details.
11+
See the official API documentation for more information.
1212

13-
en: https://devdocs.line.me/en/
13+
English: https://devdocs.line.me/en/
1414

15-
ja: https://devdocs.line.me/ja/
15+
Japanese: https://devdocs.line.me/ja/
1616

1717
Install
1818
-------
@@ -24,7 +24,7 @@ Install
2424
Synopsis
2525
--------
2626

27-
Usage is:
27+
Usage:
2828

2929
.. code:: python
3030
@@ -85,13 +85,13 @@ Create a new LineBotApi instance.
8585
8686
line_bot_api = linebot.LineBotApi('YOUR_CHANNEL_ACCESS_TOKEN')
8787
88-
You can override ``timeout`` value at each methods.
88+
You can override the ``timeout`` value for each method.
8989

9090
reply\_message(self, reply\_token, messages, timeout=None)
9191
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
9292

9393
Respond to events from users, groups, and rooms. You can get a
94-
reply\_token by a Webhook Event Object.
94+
reply\_token from a webhook event object.
9595

9696
https://devdocs.line.me/en/#reply-message
9797

@@ -163,10 +163,10 @@ https://devdocs.line.me/en/#leave
163163
164164
line_bot_api.leave_room(room_id)
165165
166-
※ Error handle
166+
※ Error handling
167167
^^^^^^^^^^^^^^
168168

169-
If LINE API server responses a error, LineBotApi raise LineBotApiError.
169+
If the LINE API server returns an error, LineBotApi raises LineBotApiError.
170170

171171
https://devdocs.line.me/en/#error-response
172172

@@ -184,7 +184,7 @@ Send message object
184184

185185
https://devdocs.line.me/en/#send-message-object
186186

187-
These following class in ``linebot.models`` package.
187+
These following classes are found in the ``linebot.models`` package.
188188

189189
TextSendMessage
190190
^^^^^^^^^^^^^^^
@@ -393,8 +393,8 @@ WebhookParser
393393
parse(self, body, signature)
394394
^^^^^^^^^^^^^^^^^^^^^^^^^^^^
395395

396-
Parse webhook body and build Event Objects List. If signature does NOT
397-
match, raise InvalidSignatureError.
396+
Parses the webhook body and builds an event object list. If the signature does NOT
397+
match, InvalidSignatureError is raised.
398398

399399
.. code:: python
400400
@@ -418,8 +418,8 @@ WebhookHandler
418418
handle(self, body, signature)
419419
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
420420

421-
Handle webhook. If signature does NOT match, raise
422-
InvalidSignatureError.
421+
Handles webhooks. If the signature does NOT match,
422+
InvalidSignatureError is raised.
423423

424424
.. code:: python
425425
@@ -428,7 +428,7 @@ InvalidSignatureError.
428428
Add handler method
429429
^^^^^^^^^^^^^^^^^^
430430

431-
You can add handler method by using ``add`` decorator.
431+
You can add a handler method by using the ``add`` decorator.
432432

433433
``add(self, event, message=None)``
434434

@@ -440,13 +440,13 @@ You can add handler method by using ``add`` decorator.
440440
event.reply_token,
441441
TextSendMessage(text=event.message.text))
442442
443-
When event is instance of MessageEvent and event.message is instance of
443+
When the event is an instance of MessageEvent and event.message is an instance of
444444
TextMessage, this handler method is called.
445445

446446
Set default handler method
447447
^^^^^^^^^^^^^^^^^^^^^^^^^^
448448

449-
You can set default handler method by using ``default`` decorator.
449+
You can set the default handler method by using the ``default`` decorator.
450450

451451
``default(self)``
452452

@@ -456,14 +456,14 @@ You can set default handler method by using ``default`` decorator.
456456
def default(event):
457457
print(event)
458458
459-
There is no handler for event, this default handler method is called.
459+
If there is no handler for an event, this default handler method is called.
460460

461461
Webhook event object
462462
~~~~~~~~~~~~~~~~~~~~
463463

464464
https://devdocs.line.me/en/#webhooks
465465

466-
These following class in ``linebot.models`` package.
466+
The following classes are found in the ``linebot.models`` package.
467467

468468
Event
469469
^^^^^
@@ -572,7 +572,7 @@ Sample echo-bot using `Flask <http://flask.pocoo.org/>`__
572572

573573
Sample bot using `Flask <http://flask.pocoo.org/>`__
574574

575-
API document
575+
API documentation
576576
------------
577577

578578
::
@@ -586,7 +586,7 @@ OR |Documentation Status|
586586
Requirements
587587
------------
588588

589-
- python >= 2.7 or >= 3.3
589+
- Python >= 2.7 or >= 3.3
590590

591591
For SDK developers
592592
------------------
@@ -600,26 +600,26 @@ First install for development.
600600
Run tests
601601
~~~~~~~~~
602602

603-
We test by using tox. We test the following versions.
603+
Test by using tox. We test against the following versions.
604604

605605
- 2.7
606606
- 3.3
607607
- 3.4
608608
- 3.5
609609

610-
If you want to run all tests and run ``flake8`` against all versions:
610+
To run all tests and to run ``flake8`` against all versions, use:
611611

612612
::
613613

614614
tox
615615

616-
If you want to run all tests against 2.7 version:
616+
To run all tests against version 2.7, use:
617617

618618
::
619619

620620
$ tox -e py27
621621

622-
If you want to run a test against 2.7 version and against specific file:
622+
To run a test against version 2.7 and against a specific file, use:
623623

624624
::
625625

examples/flask-echo/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
Sample echo-bot using [Flask](http://flask.pocoo.org/)
44

5-
## Getting Start
5+
## Getting started
66

77
```
88
$ export LINE_CHANNEL_SECRET=YOUR_LINE_CHANNEL_SECRET

examples/flask-kitchensink/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
Sample bot using [Flask](http://flask.pocoo.org/)
44

5-
## Getting Start
5+
## Getting started
66

77
```
88
$ export LINE_CHANNEL_SECRET=YOUR_LINE_CHANNEL_SECRET

examples/simple-server-echo/README.md

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
Sample echo-bot using [wsgiref.simple_server](https://docs.python.org/3/library/wsgiref.html)
44

5-
## Getting Start
5+
## Getting started
66

77
```
88
$ export LINE_CHANNEL_SECRET=YOUR_LINE_CHANNEL_SECRET
@@ -12,4 +12,3 @@ $ pip install -r requirements.txt
1212
1313
$ python app.py
1414
```
15-

0 commit comments

Comments
 (0)