Skip to content

Commit 09fddb3

Browse files
committed
Minor documentation cleanups
1 parent b3ec54a commit 09fddb3

File tree

4 files changed

+15
-15
lines changed

4 files changed

+15
-15
lines changed

lib/jujube/components/publishers.rb

+8-8
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ module Publishers
66
extend Macros
77

88
# @!method archive(options = {})
9-
# Specify an `archive` component for a job.
9+
# Specify an `archive` publisher for a job.
1010
#
1111
# See {http://ci.openstack.org/jenkins-job-builder/publishers.html#publishers.archive}.
1212
#
@@ -15,7 +15,7 @@ module Publishers
1515
standard_component :archive
1616

1717
# @!method cppcheck(options = {})
18-
# Specify a `cppcheck` component for a job.
18+
# Specify a `cppcheck` publisher for a job.
1919
#
2020
# See {http://ci.openstack.org/jenkins-job-builder/publishers.html#publishers.cppcheck}.
2121
#
@@ -24,7 +24,7 @@ module Publishers
2424
standard_component :cppcheck
2525

2626
# @!method email_ext(options = {})
27-
# Specify an `email-ext` component for a job.
27+
# Specify an `email-ext` publisher for a job.
2828
#
2929
# See {http://ci.openstack.org/jenkins-job-builder/publishers.html#publishers.email-ext}.
3030
#
@@ -42,7 +42,7 @@ module Publishers
4242
standard_component :fitnesse
4343

4444
# @!method ircbot(options = {})
45-
# Specify an `ircbot` component for a job.
45+
# Specify an `ircbot` publisher for a job.
4646
#
4747
# See {http://ci.openstack.org/jenkins-job-builder/publishers.html#publishers.ircbot}.
4848
#
@@ -51,7 +51,7 @@ module Publishers
5151
standard_component :ircbot
5252

5353
# @!method junit(options = {})
54-
# Specify a `junit` component for a job.
54+
# Specify a `junit` publisher for a job.
5555
#
5656
# See {http://ci.openstack.org/jenkins-job-builder/publishers.html#publishers.junit}.
5757
#
@@ -60,15 +60,15 @@ module Publishers
6060
standard_component :junit
6161

6262
# @!method trigger(options = {})
63-
# Specify a `trigger` component for a job.
63+
# Specify a `trigger` publisher for a job.
6464
#
6565
# See {http://ci.openstack.org/jenkins-job-builder/publishers.html#publishers.trigger}.
6666
#
6767
# @param options [Hash] The configuration options for the component.
6868
# @return [Hash] The specification for the component.
6969
standard_component :trigger
7070

71-
# Specify an `xunit` component for a job.
71+
# Specify an `xunit` publisher for a job.
7272
#
7373
# See {http://ci.openstack.org/jenkins-job-builder/publishers.html#publishers.xunit}.
7474
#
@@ -93,7 +93,7 @@ def xunit(options = {}, &block)
9393
# @!group xunit Test Types
9494

9595
# @!method unittest(options = {})
96-
# Configure a `unittest` test type for an {#xunit} component.
96+
# Configure a `unittest` test type for an {#xunit} publisher.
9797
#
9898
# See {http://ci.openstack.org/jenkins-job-builder/publishers.html#publishers.xunit}.
9999
#

lib/jujube/components/scm.rb

+1-1
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ module Scm
1616

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

lib/jujube/components/triggers.rb

+4-4
Original file line numberDiff line numberDiff line change
@@ -62,14 +62,14 @@ def url(the_url, options = {}, &block)
6262
# @!group pollurl Content Types
6363

6464
# Configure a simple content check inside a {#url} specification of a
65-
# {#pollurl} component.
65+
# {#pollurl} trigger.
6666
# @return [Hash] The specification for the content type.
6767
def simple
6868
{"simple" => true}
6969
end
7070

7171
# Configure a JSON content check inside a {#url} specification of a
72-
# {#pollurl} component.
72+
# {#pollurl} trigger.
7373
#
7474
# @param paths [String...] Zero or more JSONPath expressions. Only changes to
7575
# the parts of the JSON response that match one of the `paths` will trigger a build.
@@ -79,7 +79,7 @@ def json(*paths)
7979
end
8080

8181
# Configure an XML content check inside a {#url} specification of a
82-
# {#pollurl} component.
82+
# {#pollurl} trigger.
8383
#
8484
# @param xpaths [String...] Zero or more XPath expressions. Only changes to
8585
# the parts of the XML response that match one of the `xpaths` will trigger a build.
@@ -89,7 +89,7 @@ def xml(*xpaths)
8989
end
9090

9191
# Configure a text content check inside a {#url} specification of a
92-
# {#pollurl} component.
92+
# {#pollurl} trigger.
9393
#
9494
# @param regexes [String...] Zero or more regular expressions. Only changes to
9595
# the parts of the text response that match one of the `regexes` will trigger a build.

lib/jujube/components/wrappers.rb

+2-2
Original file line numberDiff line numberDiff line change
@@ -6,15 +6,15 @@ module Wrappers
66
extend Macros
77

88
# @!method timeout(options = {})
9-
# Specify a `timeout` component for a job.
9+
# Specify a `timeout` wrapper for a job.
1010
#
1111
# See {http://ci.openstack.org/jenkins-job-builder/publishers.html#wrappers.timeout}.
1212
#
1313
# @param options [Hash] The configuration options for the component.
1414
# @return [Hash] The specification for the component.
1515
standard_component :timeout
1616

17-
# Specify a `timestamps` component for a job.
17+
# Specify a `timestamps` wrapper for a job.
1818
#
1919
# See {http://ci.openstack.org/jenkins-job-builder/wrappers.html#wrappers.timestamps}.
2020
#

0 commit comments

Comments
 (0)