Skip to content

Commit 476b671

Browse files
authored
Fix Copy/Paste errors
1 parent 39f61fa commit 476b671

File tree

1 file changed

+12
-24
lines changed

1 file changed

+12
-24
lines changed

README.rst

Lines changed: 12 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -64,12 +64,10 @@ __ https://docs.scale.com/reference#general-image-annotation
6464
Retrieve task
6565
^^^^^^^^^^^^^
6666

67-
Check out `Scale's API documentation`__ for more information.
67+
Retrieve a task given its id. Check out `Scale's API documentation`__ for more information.
6868

6969
__ https://docs.scale.com/reference#retrieve-tasks
7070

71-
Retrieve a task given its id.
72-
7371
.. code-block :: python
7472
7573
task = client.fetch_task('asdfasdfasdfasdfasdfasdf')
@@ -79,12 +77,10 @@ Retrieve a task given its id.
7977
List Tasks
8078
^^^^^^^^^^
8179

82-
Check out `Scale's API documentation`__ for more information.
80+
Retrieve a list of tasks, with optional filter by start and end date/time. 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. Check out `Scale's API documentation`__ for more information.
8381

8482
__ https://docs.scale.com/reference#list-multiple-tasks
8583

86-
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.
87-
8884
.. code-block :: python
8985
9086
next_token = None;
@@ -109,12 +105,10 @@ Retrieve a list of tasks, with optional filter by stand and end date/type. Pagin
109105
Cancel Task
110106
^^^^^^^^^^^
111107

112-
Check out `Scale's API documentation`__ for more information.
108+
Cancel a task given its id if work has not stared on the task (task status is `queued` in the UI). Check out `Scale's API documentation`__ for more information.
113109

114110
__ https://docs.scale.com/reference#cancel-task
115111

116-
Cancel a task given its id if work has not stared on the task (task status is "que).
117-
118112
.. code-block :: python
119113
120114
task = client.cancel_task('asdfasdfasdfasdfasdfasdf')
@@ -125,7 +119,7 @@ _______
125119
Create Batch
126120
^^^^^^^^^^^^
127121

128-
Check out `Scale's API documentation`__ for more information.
122+
Create a new Batch. Check out `Scale's API documentation`__ for more information.
129123

130124
__ https://docs.scale.com/reference#batch-creation
131125

@@ -140,7 +134,7 @@ __ https://docs.scale.com/reference#batch-creation
140134
Finalize Batceh
141135
^^^^^^^^^^^^^^^
142136

143-
Check out `Scale's API documentation`__ for more information.
137+
Finalize a Batch. Check out `Scale's API documentation`__ for more information.
144138

145139
__ https://docs.scale.com/reference#batch-finalization
146140

@@ -151,7 +145,7 @@ __ https://docs.scale.com/reference#batch-finalization
151145
Check Batch Status
152146
^^^^^^^^^^^^^^^^^^
153147

154-
Check out `Scale's API documentation`__ for more information.
148+
Get the status of a Batch. Check out `Scale's API documentation`__ for more information.
155149

156150
__ https://docs.scale.com/reference#batch-status
157151

@@ -162,7 +156,7 @@ __ https://docs.scale.com/reference#batch-status
162156
Retrieve Batch
163157
^^^^^^^^^^^^^^
164158

165-
Check out `Scale's API documentation`__ for more information.
159+
Retrieve a single Batch. Check out `Scale's API documentation`__ for more information.
166160

167161
__ https://docs.scale.com/reference#batch-retrieval
168162

@@ -173,12 +167,10 @@ __ https://docs.scale.com/reference#batch-retrieval
173167
List Batches
174168
^^^^^^^^^^^^
175169

176-
Check out `Scale's API documentation`__ for more information.
170+
Retrieve a list of Batches. Check out `Scale's API documentation`__ for more information.
177171

178172
__ https://docs.scale.com/reference#batch-list
179173

180-
Retrieve a list of batches
181-
182174
.. code-block :: python
183175
184176
next_token = None;
@@ -203,7 +195,7 @@ ________
203195
Create Project
204196
^^^^^^^^^^^^^^
205197

206-
Check out `Scale's API documentation`__ for more information.
198+
Create a new Project. Check out `Scale's API documentation`__ for more information.
207199

208200
__ https://docs.scale.com/reference#project-creation
209201

@@ -218,7 +210,7 @@ __ https://docs.scale.com/reference#project-creation
218210
Retrieve Project
219211
^^^^^^^^^^^^^^^^
220212

221-
Check out `Scale's API documentation`__ for more information.
213+
Retrieve a single Project. Check out `Scale's API documentation`__ for more information.
222214

223215
__ https://docs.scale.com/reference#project-retrieval
224216

@@ -229,13 +221,11 @@ __ https://docs.scale.com/reference#project-retrieval
229221
List Projects
230222
^^^^^^^^^^^^^
231223

232-
This function does not take any arguments. It will return information for every project.
224+
This function does not take any arguments. Retrieve a list of every Project.
233225
Check out `Scale's API documentation`__ for more information.
234226

235227
__ https://docs.scale.com/reference#batch-list
236228

237-
Retrieve a list of batches
238-
239229
.. code-block :: python
240230
241231
counter = 0
@@ -247,12 +237,10 @@ Retrieve a list of batches
247237
Update Project
248238
^^^^^^^^^^^^^^
249239

250-
Check out `Scale's API documentation`__ for more information.
240+
Creates a new version of the Project. Check out `Scale's API documentation`__ for more information.
251241

252242
__ https://docs.scale.com/reference#project-update-parameters
253243

254-
Retrieve a list of batches
255-
256244
.. code-block :: python
257245
258246
data = client.update_project(

0 commit comments

Comments
 (0)