Skip to content

Commit 86b3600

Browse files
committed
Add links to AWS in README
1 parent f406a43 commit 86b3600

File tree

2 files changed

+13
-4
lines changed

2 files changed

+13
-4
lines changed

README.md

Lines changed: 7 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
11
# Python interface to SWF
2-
Typed Python interface to AWS Simple Workflow service
2+
3+
Typed Python interface to [AWS Simple Workflow Service](https://aws.amazon.com/swf/).
34

45
* Type annotations
56
* Explicit exceptions
@@ -45,11 +46,15 @@ for task in state.tasks:
4546
```
4647

4748
### Terminology
48-
This library uses a slight terminology change from SWF SDKs/APIs:
49+
50+
This library has a slight change in terminology from AWS [SDKs](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/swf.html)/[APIs](https://docs.aws.amazon.com/amazonswf/latest/apireference/Welcome.html)/[docs](https://docs.aws.amazon.com/amazonswf/latest/developerguide/swf-welcome.html):
51+
4952
* Workflow type -> workflow
5053
* Workflow execution -> execution
5154
* Workflow execution `workflowId` -> execution ID
5255
* Activity type -> activity
5356
* Activity task -> task
5457
* Activity worker -> worker
5558
* Activity task `activityId` -> task ID
59+
60+
This is to simplify symbol names.

docs/src/index.rst

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
*swf-typed* - Python interface to SWF
22
=====================================
33

4-
Typed Python interface to AWS Simple Workflow service
4+
Typed Python interface to `AWS Simple Workflow Service <https://aws.amazon.com/swf/>`_.
55

66
* Type annotations
77
* Explicit exceptions
@@ -64,7 +64,9 @@ Example
6464
Terminology
6565
^^^^^^^^^^^
6666

67-
This library uses a slight terminology change from SWF SDKs/APIs:
67+
This library has a slight change in terminology from AWS `SDKs
68+
<https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/swf.html>`_/`APIs
69+
<https://docs.aws.amazon.com/amazonswf/latest/apireference/Welcome.html>`_/`docs <https://docs.aws.amazon.com/amazonswf/latest/developerguide/swf-welcome.html>`_:
6870

6971
* Workflow type -> workflow
7072
* Workflow execution -> execution
@@ -73,3 +75,5 @@ This library uses a slight terminology change from SWF SDKs/APIs:
7375
* Activity task -> task
7476
* Activity worker -> worker
7577
* Activity task ``activityId`` -> task ID
78+
79+
This is to simplify symbol names.

0 commit comments

Comments
 (0)