subjects.rb in panoptes-client-0.1.1

- old
+ new

@@ -1,7 +1,13 @@
 module Panoptes
   class Client
     module Subjects
+      # Retire a subject for a workflow
+      #
+      # @todo Add this endpoint to the Apiary docs and add a see-reference here.
+      # @param workflow_id [Integer] the ID of a workflow
+      # @param subject_id  [Integer] the ID of a subject associated with that workflow (through one of the assigned subject_sets)
+      # @return nothing
       def retire_subject(workflow_id, subject_id)
         post("/workflows/#{workflow_id}/retired_subjects", {
           admin: true,
           subject_id: subject_id
         })