Remove todos and tidying

Author: Samze

app/models/runtime/deployment_model.rb

@@ -90,7 +90,6 @@ def before_update
       super
       set_status_updated_at
     end
-    # TODO: documentation
 
     def before_create
       self.canary_current_step = 1 if strategy == DeploymentModel::CANARY_STRATEGY

docs/v3/source/includes/resources/deployments/_create.md.erb

@@ -78,7 +78,7 @@ Name | Type | Description | Default
 **revision**<sup>[1]</sup> | _object_ | The [revision](#revisions) whose droplet to deploy for the app; this will update the app's [current droplet](#get-current-droplet-association-for-an-app) to this droplet |
 **strategy** | _string_ | The strategy to use for the deployment | `rolling`
 **options.max_in_flight** | _integer_ | The maximum number of new instances to deploy simultaneously | 1
-**options.canary.steps** | _array of [canary step objects](#canary-steps-object)_ | Canary steps to use for the deployment An array of canary steps to use for the deployment
+**options.canary.steps** | _array of [canary step objects](#canary-steps-object)_ | An array of canary steps to use for the deployment
 **metadata.labels** | [_label object_](#labels) | Labels applied to the deployment
 **metadata.annotations**  | [_annotation object_](#annotations) | Annotations applied to the deployment
 

docs/v3/source/includes/resources/deployments/_object.md.erb

@@ -16,11 +16,11 @@ Name | Type | Description
 **status.reason** | _string_ | The reason for the status of the deployment;<br>following list represents valid values:<br>1. If **status.value** is `ACTIVE`<br>- `DEPLOYING`<br>- `PAUSED` (only valid for canary deployments) <br>- `CANCELING`<br>2. If **status.value** is `FINALIZED`<br>- `DEPLOYED`<br>- `CANCELED`<br>- `SUPERSEDED` (another deployment created for app before completion)<br>
 **status.details.last_successful_healthcheck** | _[timestamp](#timestamps)_ | Timestamp of the last successful healthcheck
 **status.details.last_status_change** | _[timestamp](#timestamps)_ | Timestamp of last change to status.value or status.reason**status.details.last_status_change** | _[timestamp](#timestamps)_ | Timestamp of last change to status.value or status.reason
-**status.canary.steps.current** | _integer_ | The current canary step. Only available deployments with strategy 'canary'. (experimental)
-**status.canary.steps.total** | _integer_ |  The total number of canary steps. Only available deployments with strategy 'canary'. (experimental)
+**status.canary.steps.current** | _integer_ | The current canary step. Only available for deployments with strategy 'canary'. (experimental)
+**status.canary.steps.total** | _integer_ |  The total number of canary steps. Only available for deployments with strategy 'canary'. (experimental)
 **strategy** | _string_ | Strategy used for the deployment; supported strategies are `rolling` and `canary` (experimental)
 **options.max_in_flight** | _integer_ | The maximum number of new instances to deploy simultaneously
-**options.canary.steps** | _array of [canary step objects](#canary-steps-object)_ | Canary steps to use for the deployment. Only available deployments with strategy 'canary'. (experimental)
+**options.canary.steps** | _array of [canary step objects](#canary-steps-object)_ | Canary steps to use for the deployment. Only available for deployments with strategy 'canary'. (experimental)
 **droplet.guid** | _string_ | The droplet guid that the deployment is transitioning the app to
 **previous_droplet.guid** | _string_ | The app's [current droplet guid](#get-current-droplet-association-for-an-app) before the deployment was created
 **new_processes** | _array_ | List of processes created as part of the deployment

lib/cloud_controller/deployment_updater/actions/scale.rb

@@ -23,7 +23,6 @@ def call
           up_scaler = UpScaler.new(deployment, logger, interim_desired_instance_count, instance_count_summary)
 
           deployment.db.transaction do
-            # TODO: write scale test for prepaused state
             return unless [DeploymentModel::DEPLOYING_STATE, DeploymentModel::PREPAUSED_STATE].include?(deployment.lock!.state)
             return unless up_scaler.can_scale? || down_scaler.can_downscale?
 

lib/cloud_controller/deployment_updater/updater.rb

@@ -22,7 +22,6 @@ def scale
 
       def canary
         with_error_logging('error-canarying-deployment') do
-          # TODO: do we need to pass in deployment.original_web_process_instance_count + 1 if there is a single canary instance?
           finished = Actions::Scale.new(deployment, logger, deployment.canary_total_instances, deployment.current_canary_instance_target).call
           if finished
             deployment.update(
@@ -33,7 +32,6 @@ def canary
             )
             logger.info("paused-canary-deployment-for-#{deployment.guid}")
           end
-          # Actions::Canary.new(deployment, logger).call
           logger.info("ran-canarying-deployment-for-#{deployment.guid}")
         end
       end

spec/unit/messages/deployment_create_message_spec.rb

@@ -271,7 +271,7 @@ module VCAP::CloudController
               expect(message.errors[:'options.canary.steps.instance_weight']).to include('must be sorted in ascending order')
             end
 
-            it 'errors if any instance_weights are not a non-integer numeric' do
+            it 'errors if any instance_weights are a non-integer numeric' do
               body['options'] = { canary: { steps: [{ instance_weight: 2 }, { instance_weight: 25.0 }] } }
               message = DeploymentCreateMessage.new(body)
               expect(message).not_to be_valid

spec/unit/messages/validators_spec.rb

@@ -1,4 +1,3 @@
-# require 'spec_helper'
 require 'lightweight_spec_helper'
 require 'messages/validators'
 require 'messages/base_message'