lib/stubs/aws_stubs.rb in cloud_powers-0.2.7.1 vs lib/stubs/aws_stubs.rb in cloud_powers-0.2.7.2

@@ -33,13 +33,14 @@
       # * opts +Hash+ (optional)
       # * * stub_responses - defaulted to +false+ but it can be overriden with the desired responses for local testing
       # * * region - defaulted to use the <tt>#region()</tt> method
       # * * AWS::Credentials object, which will also scour the context and environment for your keys
       #
-      # === Returns
+      # Returns
       # <tt>AWS::EC2::Client</tt>
-      # === Sample Usage
+      #
+      # Example
       #   config = stub_responses: {
       #     run_instances: {
       #       instances: [{ instance_id: 'asd-1234', launch_time: Time.now, state: { name: 'running' }]
       #     },
       #     describe_instances: {
@@ -89,20 +90,21 @@
           }
         }
       end
 
       # Stub data for a SNS client
+      #
       # Parameters
       # * opts +Hash+
       # * * stub_responses: defaulted to false but it can be overriden with the desired responses for local testing
       # * * region: defaulted to use the `#region()` method
       # * * AWS::Credentials object, which will also scour the context and environment for your keys
       #
-      # === Returns
+      # Returns
       # AWS::SNS client
       #
-      # === Example
+      # Example
       #   config = {
       #     stub_responses: {
       #       create_topic: {},
       #       delete_topic: {},
       #       list_topics: [],
@@ -134,14 +136,14 @@
       # * opts <tt>Hash</tt>
       # * * stub_responses: defaulted to false but it can be overriden with the desired responses for local testing
       # * * region: defaulted to use the `#region()` method
       # * * AWS::Credentials object, which will also scour the context and environment for your keys
       #
-      # === Returns
+      # Returns
       # AWS::Kinesis client
       #
-      # === Example
+      # Example
       #   config = {
       #     stub_responses: {
       #       create_stream: {},
       #         put_record: {
       #           shard_id: opts[:shard_id] || 'idididididididid',
@@ -203,14 +205,14 @@
       # * opts <tt>Hash</tt>
       # * * stub_responses: defaulted to false but it can be overriden with the desired responses for local testing
       # * * region: defaulted to use the `#region()` method
       # * * AWS::Credentials object, which will also scour the context and environment for your keys
       #
-      # === Returns
+      # Returns
       # AWS::S3 client
       #
-      # === Example
+      # Example
       #   config = {
       #     stub_responses: {
       #       head_bucket: {}
       #     }
       #   }
@@ -232,13 +234,13 @@
       # * opts <tt>Hash</tt>
       # * * stub_responses: defaulted to false but it can be overriden with the desired responses for local testing
       # * * region: defaulted to use the `#region()` method
       # * * AWS::Credentials object, which will also scour the context and environment for your keys
       #
-      # === Returns
+      # Returns
       # AWS::SQS client
       #
-      # === Example
+      # Example
       #   create_queue('someQueue') # uses AWS::SQS
       #   some_queue_url = queue_search('someQueue').first # uses AWS::SQS
       def self.queue_stub(opts = {})
         {
           stub_responses: {