Skip to content

Commit 86fba09

Browse files
zamithkarmi
authored andcommitted
[EXT] Fixed incorrect name for the testing cluster "number of nodes" option in the documentation
Both the readme and the class level docs refer to what I assume is the old name of the option to configure the number of nodes in the test cluster. This change addresses the need. Closes #366
1 parent 5cb8d7e commit 86fba09

File tree

2 files changed

+6
-6
lines changed

2 files changed

+6
-6
lines changed

elasticsearch-extensions/README.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -136,10 +136,10 @@ Start the cluster on specific port, with a specific Elasticsearch version, numbe
136136
require 'elasticsearch/extensions/test/cluster'
137137

138138
Elasticsearch::Extensions::Test::Cluster.start \
139-
cluster_name: "my-testing-cluster",
140-
command: "/usr/local/Cellar/elasticsearch/0.90.10/bin/elasticsearch",
141-
port: 9350,
142-
nodes: 3
139+
cluster_name: "my-testing-cluster",
140+
command: "/usr/local/Cellar/elasticsearch/0.90.10/bin/elasticsearch",
141+
port: 9350,
142+
number_of_nodes: 3
143143

144144
# Starting 3 Elasticsearch nodes.....................
145145
# --------------------------------------------------------------------------------

elasticsearch-extensions/lib/elasticsearch/extensions/test/cluster.rb

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -174,7 +174,7 @@ class Cluster
174174
# Create a new instance of the Cluster class
175175
#
176176
# @option arguments [String] :cluster_name Cluster name (default: `elasticsearch_test`)
177-
# @option arguments [Integer] :nodes Number of desired nodes (default: 2)
177+
# @option arguments [Integer] :number_of_nodes Number of desired nodes (default: 2)
178178
# @option arguments [String] :command Elasticsearch command (default: `elasticsearch`)
179179
# @option arguments [String] :port Starting port number; will be auto-incremented (default: 9250)
180180
# @option arguments [String] :node_name The node name (will be appended with a number)
@@ -224,7 +224,7 @@ def initialize(arguments={})
224224
# @example Start a cluster with a custom configuration
225225
# Elasticsearch::Extensions::Test::Cluster::Cluster.new(
226226
# cluster_name: 'my-cluster',
227-
# nodes: 3,
227+
# number_of_nodes: 3,
228228
# node_name: 'my-node',
229229
# port: 9350
230230
# ).start

0 commit comments

Comments
 (0)