Minor documentation cleanups

Author: randycoulman

lib/jujube/components/publishers.rb

@@ -6,7 +6,7 @@ module Publishers
       extend Macros
 
       # @!method archive(options = {})
-      # Specify an `archive` component for a job.
+      # Specify an `archive` publisher for a job.
       #
       # See {http://ci.openstack.org/jenkins-job-builder/publishers.html#publishers.archive}.
       #
@@ -15,7 +15,7 @@ module Publishers
       standard_component :archive
 
       # @!method cppcheck(options = {})
-      # Specify a `cppcheck` component for a job.
+      # Specify a `cppcheck` publisher for a job.
       #
       # See {http://ci.openstack.org/jenkins-job-builder/publishers.html#publishers.cppcheck}.
       #
@@ -24,7 +24,7 @@ module Publishers
       standard_component :cppcheck
 
       # @!method email_ext(options = {})
-      # Specify an `email-ext` component for a job.
+      # Specify an `email-ext` publisher for a job.
       #
       # See {http://ci.openstack.org/jenkins-job-builder/publishers.html#publishers.email-ext}.
       #
@@ -42,7 +42,7 @@ module Publishers
       standard_component :fitnesse
 
       # @!method ircbot(options = {})
-      # Specify an `ircbot` component for a job.
+      # Specify an `ircbot` publisher for a job.
       #
       # See {http://ci.openstack.org/jenkins-job-builder/publishers.html#publishers.ircbot}.
       #
@@ -51,7 +51,7 @@ module Publishers
       standard_component :ircbot
 
       # @!method junit(options = {})
-      # Specify a `junit` component for a job.
+      # Specify a `junit` publisher for a job.
       #
       # See {http://ci.openstack.org/jenkins-job-builder/publishers.html#publishers.junit}.
       #
@@ -60,15 +60,15 @@ module Publishers
       standard_component :junit
 
       # @!method trigger(options = {})
-      # Specify a `trigger` component for a job.
+      # Specify a `trigger` publisher for a job.
       #
       # See {http://ci.openstack.org/jenkins-job-builder/publishers.html#publishers.trigger}.
       #
       # @param options [Hash] The configuration options for the component.
       # @return [Hash] The specification for the component.
       standard_component :trigger
 
-      # Specify an `xunit` component for a job.
+      # Specify an `xunit` publisher for a job.
       #
       # See {http://ci.openstack.org/jenkins-job-builder/publishers.html#publishers.xunit}.
       #
@@ -93,7 +93,7 @@ def xunit(options = {}, &block)
       # @!group xunit Test Types
 
       # @!method unittest(options = {})
-      # Configure a `unittest` test type for an {#xunit} component.
+      # Configure a `unittest` test type for an {#xunit} publisher.
       #
       # See {http://ci.openstack.org/jenkins-job-builder/publishers.html#publishers.xunit}.
       #

lib/jujube/components/scm.rb

@@ -16,7 +16,7 @@ module Scm
 
       # Specify a `store` SCM for a job.
       #
-      # This trigger requires support in jenkins-job-builder that has not yet been merged.
+      # This SCM requires support in jenkins-job-builder that has not yet been merged.
       # See {https://review.openstack.org/85729} for the patch.
       #
       # `store` can watch multiple pundles (packages or bundles) The specification for each

lib/jujube/components/triggers.rb

@@ -62,14 +62,14 @@ def url(the_url, options = {}, &block)
       # @!group pollurl Content Types
 
       # Configure a simple content check inside a {#url} specification of a
-      # {#pollurl} component.
+      # {#pollurl} trigger.
       # @return [Hash] The specification for the content type.
       def simple
         {"simple" => true}
       end
 
       # Configure a JSON content check inside a {#url} specification of a
-      # {#pollurl} component.
+      # {#pollurl} trigger.
       #
       # @param paths [String...] Zero or more JSONPath expressions.  Only changes to
       #   the parts of the JSON response that match one of the `paths` will trigger a build.
@@ -79,7 +79,7 @@ def json(*paths)
       end
 
       # Configure an XML content check inside a {#url} specification of a
-      # {#pollurl} component.
+      # {#pollurl} trigger.
       #
       # @param xpaths [String...] Zero or more XPath expressions.  Only changes to
       #   the parts of the XML response that match one of the `xpaths` will trigger a build.
@@ -89,7 +89,7 @@ def xml(*xpaths)
       end
 
       # Configure a text content check inside a {#url} specification of a
-      # {#pollurl} component.
+      # {#pollurl} trigger.
       #
       # @param regexes [String...] Zero or more regular expressions.  Only changes to
       #   the parts of the text response that match one of the `regexes` will trigger a build.

lib/jujube/components/wrappers.rb

@@ -6,15 +6,15 @@ module Wrappers
       extend Macros
 
       # @!method timeout(options = {})
-      # Specify a `timeout` component for a job.
+      # Specify a `timeout` wrapper for a job.
       #
       # See {http://ci.openstack.org/jenkins-job-builder/publishers.html#wrappers.timeout}.
       #
       # @param options [Hash] The configuration options for the component.
       # @return [Hash] The specification for the component.
       standard_component :timeout
 
-      # Specify a `timestamps` component for a job.
+      # Specify a `timestamps` wrapper for a job.
       #
       # See {http://ci.openstack.org/jenkins-job-builder/wrappers.html#wrappers.timestamps}.
       #