(maint) improve documentation [cp to pit]

tkishel · Oct 18, 2019 · 2a6efae · 2a6efae
1 parent 4eb14cc
commit 2a6efae
Show file tree

Hide file tree

Showing 2 changed files with 5 additions and 5 deletions.
diff --git a/lib/puppet_x/puppetlabs/tune.rb b/lib/puppet_x/puppetlabs/tune.rb
@@ -407,7 +407,7 @@ def collect_optimized_node(certname, role, node)
         @collected_nodes[certname] = properties
       end
 
-      # Establish an intuitive output order of hosts.
+      # Establish an intuitive output (singletons, multiples) order of hosts.
 
       def output_order(role)
         case role
@@ -453,7 +453,7 @@ def collect_optimized_settings_common_to_all_nodes
       #
 
       # Interface to ::Inventory and ::Query classes.
-      # Identify PE Infrastructure nodes by role, based upon the classes of the node.
+      # Identify PE Infrastructure nodes by role, based upon the PE classes declared on the node.
 
       def collect_infrastructure_nodes
         if using_inventory?

diff --git a/lib/puppet_x/puppetlabs/tune/calculate.rb b/lib/puppet_x/puppetlabs/tune/calculate.rb
@@ -36,7 +36,7 @@ def initialize(options)
 
         # Masters, Replicas, and Compilers, in Monolithic or Split Infrastructures
         # Services: pe-puppetserver and (optionally) all other services.
-        # Levels and ratios model https://puppet.com/docs/pe/latest/configuring/tuning_monolithic.html
+        # Ratios model https://puppet.com/docs/pe/latest/configuring/tuning_monolithic.html
 
         def calculate_master_settings(node)
           percent_cpu_puppetdb     = 0.25
@@ -219,7 +219,7 @@ def calculate_master_settings(node)
             settings['params']['puppet_enterprise::profile::puppetdb::gc_interval'] = 0
           end
 
-          # Increase max_connections when a large number of connections from compilers exceeds the default.
+          # Increase max_connections when the potential number of connections from compilers exceeds the default.
 
           if node['classes']['database'] && node['infrastructure']['compiler_connections']
             if node['infrastructure']['compiler_connections'] > default_database_max_connections
@@ -310,7 +310,7 @@ def calculate_database_settings(node)
           settings['params']['puppet_enterprise::profile::database::shared_buffers'] = "#{ram_database}MB"
           settings['totals']['RAM']['used'] += ram_database
 
-          # Increase max_connections when a large number of connections from compilers exceeds the default.
+          # Increase max_connections when the potential number of connections from compilers exceeds the default.
 
           if node['infrastructure']['compiler_connections']
             if node['infrastructure']['compiler_connections'] > default_database_max_connections