Skip to content

Commit 88fd16e

Browse files
committed
reword
1 parent d2ebc45 commit 88fd16e

File tree

1 file changed

+17
-17
lines changed

1 file changed

+17
-17
lines changed

README.rst

Lines changed: 17 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -25,19 +25,19 @@ _____
2525
Most of these methods will return a `scaleapi.Task` object, which will contain information
2626
about the json response (task_id, status...).
2727

28-
Any parameter available in scales API documentation_ can be passed as an argument option with the corresponding type.
28+
Any parameter available in `Scale's API documentation`__ can be passed as an argument option with the corresponding type.
2929

30-
.. _documentation: https://docs.scale.com/reference#task-object
30+
__ https://docs.scale.com/reference#task-object
3131

3232
The following endpoints for tasks are available:
3333

3434
Create Task
3535
^^^^^^^^^^^
3636

3737
This method can be used for any Scale supported task type using the following format:
38-
`client.create_{{Task Type}}_task(...)` and passing the applicable values into the function definition. The applicable fields and further information for each task type can be found in scales API docs `here`__ for further information.
38+
`client.create_{{Task Type}}_task(...)` and passing the applicable values into the function definition. The applicable fields and further information for each task type can be found in `Scale's API docs`__ for further information.
3939

40-
.. __: https://docs.scale.com/reference#general-image-annotation
40+
__ https://docs.scale.com/reference#general-image-annotation
4141

4242
.. code-block:: python
4343
@@ -59,9 +59,9 @@ This method can be used for any Scale supported task type using the following fo
5959
Retrieve task
6060
^^^^^^^^^^^^^
6161

62-
Check API documentation `here`__ for further information.
62+
`Check API documentation`__ for more information.
6363

64-
.. __: https://docs.scale.com/reference#retrieve-tasks
64+
__ https://docs.scale.com/reference#retrieve-tasks
6565

6666
Retrieve a task given its id.
6767

@@ -74,7 +74,7 @@ Retrieve a task given its id.
7474
List Tasks
7575
^^^^^^^^^^
7676

77-
Check API documentation `here`__ for further information.
77+
`Check API documentation`__ for more information.
7878

7979
__ https://docs.scale.com/reference#list-multiple-tasks
8080

@@ -104,7 +104,7 @@ Retrieve a list of tasks, with optional filter by stand and end date/type. Pagin
104104
Cancel Task
105105
^^^^^^^^^^^
106106

107-
Check API documentation `here`__ for further information.
107+
`Check API documentation`__ for more information.
108108

109109
__ https://docs.scale.com/reference#cancel-task
110110

@@ -120,7 +120,7 @@ _______
120120
Create Batch
121121
^^^^^^^^^^^^
122122

123-
Check API documentation `here`__ for further information.
123+
`Check API documentation`__ for more information.
124124

125125
__ https://docs.scale.com/reference#batch-creation
126126

@@ -135,7 +135,7 @@ __ https://docs.scale.com/reference#batch-creation
135135
Finalize Batceh
136136
^^^^^^^^^^^^^^^
137137

138-
Check API documentation `here`__ for further information.
138+
`Check API documentation`__ for more information.
139139

140140
__ https://docs.scale.com/reference#batch-finalization
141141

@@ -146,7 +146,7 @@ __ https://docs.scale.com/reference#batch-finalization
146146
Check Batch Status
147147
^^^^^^^^^^^^^^^^^^
148148

149-
Check API documentation `here`__ for further information.
149+
`Check API documentation`__ for more information.
150150

151151
__ https://docs.scale.com/reference#batch-status
152152

@@ -157,7 +157,7 @@ __ https://docs.scale.com/reference#batch-status
157157
Retrieve Batch
158158
^^^^^^^^^^^^^^
159159

160-
Check API documentation `here`__ for further information.
160+
`Check API documentation`__ for more information.
161161

162162
__ https://docs.scale.com/reference#batch-retrieval
163163

@@ -168,7 +168,7 @@ __ https://docs.scale.com/reference#batch-retrieval
168168
List Batches
169169
^^^^^^^^^^^^
170170

171-
Check API documentation `here`__ for further information.
171+
`Check API documentation`__ for more information.
172172

173173
__ https://docs.scale.com/reference#batch-list
174174

@@ -198,7 +198,7 @@ ________
198198
Create Project
199199
^^^^^^^^^^^^^^
200200

201-
Check API documentation `here`__ for further information.
201+
`Check API documentation`__ for more information.
202202

203203
__ https://docs.scale.com/reference#project-creation
204204

@@ -213,7 +213,7 @@ __ https://docs.scale.com/reference#project-creation
213213
Retrieve Project
214214
^^^^^^^^^^^^^^^^
215215

216-
Check API documentation `here`__ for further information.
216+
`Check API documentation`__ for more information.
217217

218218
__ https://docs.scale.com/reference#project-retrieval
219219

@@ -225,7 +225,7 @@ List Projects
225225
^^^^^^^^^^^^^
226226

227227
This function does not take any arguments. It will return information for every project.
228-
Check API documentation `here`__ for further information.
228+
`Check API documentation`__ for more information.
229229

230230
__ https://docs.scale.com/reference#batch-list
231231

@@ -242,7 +242,7 @@ Retrieve a list of batches
242242
Update Project
243243
^^^^^^^^^^^^^^
244244

245-
Check API documentation `here`__ for further information.
245+
`Check API documentation`__ for more information.
246246

247247
__ https://docs.scale.com/reference#project-update-parameters
248248

0 commit comments

Comments
 (0)