Skip to content

Commit 9041d23

Browse files
authored
Merge pull request #23 from scaleapi/nofel-fix-hyperlinks
Update README.rst
2 parents cb3f839 + 94e5635 commit 9041d23

File tree

1 file changed

+28
-28
lines changed

1 file changed

+28
-28
lines changed

README.rst

Lines changed: 28 additions & 28 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 the 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 documentation`__.
3939

40-
\_\_ hhttps://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 `this`\_\_ for further information.
62+
Check out `Scale's 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,9 +74,9 @@ Retrieve a task given its id.
7474
List Tasks
7575
^^^^^^^^^^
7676

77-
Check `this`\_\_ for further information.
77+
Check out `Scale's API documentation`__ for more information.
7878

79-
\_\_ https://docs.scale.com/reference#list-multiple-tasks
79+
__ https://docs.scale.com/reference#list-multiple-tasks
8080

8181
Retrieve a list of tasks, with optional filter by stand and end date/type. Paginated with `next_token`. The return value is a `scaleapi.Tasklist`, which acts as a list, but also has fields for the total number of tasks, the limit and offset, and whether or not there's more.
8282

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

107-
Check `this`\_\_ for further information.
107+
Check out `Scale's API documentation`__ for more information.
108108

109-
\_\_ https://docs.scale.com/reference#cancel-task
109+
__ https://docs.scale.com/reference#cancel-task
110110

111111
Cancel a task given its id if work has not stared on the task (task status is "que).
112112

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

123-
Check `this`\_\_ for further information.
123+
Check out `Scale's API documentation`__ for more information.
124124

125-
\_\_ https://docs.scale.com/reference#batch-creation
125+
__ https://docs.scale.com/reference#batch-creation
126126

127127
.. code-block:: python
128128
@@ -135,9 +135,9 @@ Check `this`\_\_ for further information.
135135
Finalize Batceh
136136
^^^^^^^^^^^^^^^
137137

138-
Check `this`\_\_ for further information.
138+
Check out `Scale's API documentation`__ for more information.
139139

140-
\_\_ https://docs.scale.com/reference#batch-finalization
140+
__ https://docs.scale.com/reference#batch-finalization
141141

142142
.. code-block:: python
143143
@@ -146,9 +146,9 @@ Check `this`\_\_ for further information.
146146
Check Batch Status
147147
^^^^^^^^^^^^^^^^^^
148148

149-
Check `this`\_\_ for further information.
149+
Check out `Scale's API documentation`__ for more information.
150150

151-
\_\_ https://docs.scale.com/reference#batch-status
151+
__ https://docs.scale.com/reference#batch-status
152152

153153
.. code-block:: python
154154
@@ -157,9 +157,9 @@ Check `this`\_\_ for further information.
157157
Retrieve Batch
158158
^^^^^^^^^^^^^^
159159

160-
Check `this`\_\_ for further information.
160+
Check out `Scale's API documentation`__ for more information.
161161

162-
\_\_ https://docs.scale.com/reference#batch-retrieval
162+
__ https://docs.scale.com/reference#batch-retrieval
163163

164164
.. code-block:: python
165165
@@ -168,9 +168,9 @@ Check `this`\_\_ for further information.
168168
List Batches
169169
^^^^^^^^^^^^
170170

171-
Check `this`\_\_ for further information.
171+
Check out `Scale's API documentation`__ for more information.
172172

173-
\_\_ https://docs.scale.com/reference#batch-list
173+
__ https://docs.scale.com/reference#batch-list
174174

175175
Retrieve a list of batches
176176

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

201-
Check `this`\_\_ for further information.
201+
Check out `Scale's API documentation`__ for more information.
202202

203-
\_\_ https://docs.scale.com/reference#project-creation
203+
__ https://docs.scale.com/reference#project-creation
204204

205205
.. code-block:: python
206206
@@ -213,9 +213,9 @@ Check `this`\_\_ for further information.
213213
Retrieve Project
214214
^^^^^^^^^^^^^^^^
215215

216-
Check `this`\_\_ for further information.
216+
Check out `Scale's API documentation`__ for more information.
217217

218-
\_\_ https://docs.scale.com/reference#project-retrieval
218+
__ https://docs.scale.com/reference#project-retrieval
219219

220220
.. code-block:: python
221221
@@ -225,9 +225,9 @@ List Projects
225225
^^^^^^^^^^^^^
226226

227227
This function does not take any arguments. It will return information for every project.
228-
Check `this`\_\_ for further information.
228+
Check out `Scale's API documentation`__ for more information.
229229

230-
\_\_ https://docs.scale.com/reference#batch-list
230+
__ https://docs.scale.com/reference#batch-list
231231

232232
Retrieve a list of batches
233233

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

245-
Check `this`\_\_ for further information.
245+
Check out `Scale's API documentation`__ for more information.
246246

247-
\_\_ https://docs.scale.com/reference#project-update-parameters
247+
__ https://docs.scale.com/reference#project-update-parameters
248248

249249
Retrieve a list of batches
250250

0 commit comments

Comments
 (0)