Skip to content

Commit 028df3a

Browse files
committed
Fixed Grammar problems with some of the documentation
1 parent b61e110 commit 028df3a

2 files changed

Lines changed: 26 additions & 16 deletions

File tree

lib/softlayer/ServerFirewall.rb

Lines changed: 12 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -10,10 +10,10 @@ module SoftLayer
1010
# SoftLayer environment that exists in a 1 to 1 relationship
1111
# with a particular server (either Bare Metal or Virtual).
1212
#
13-
# This is also called a "Shared Firewall" in some documentation
13+
# This is also called a "Shared Firewall" in some documentation.
1414
#
1515
# Instances of this class rougly correspond to instances of the
16-
# SoftLayer_Network_Component_Firewall service entity
16+
# SoftLayer_Network_Component_Firewall service entity.
1717
#
1818
class ServerFirewall < SoftLayer::ModelBase
1919
include ::SoftLayer::DynamicAttribute
@@ -28,9 +28,9 @@ class ServerFirewall < SoftLayer::ModelBase
2828

2929
##
3030
# :attr_reader:
31-
# The firewall rules assigned to this firewall. These rules will
31+
# The firewall rules assigned to this firewall. These rules will
3232
# be read from the network API every time you ask for the value
33-
# of this property. To change the rules on the server use the
33+
# of this property. To change the rules on the server use the
3434
# asymmetric method change_rules!
3535
sl_dynamic_attr :rules do |firewall_rules|
3636
firewall_rules.should_update? do
@@ -90,7 +90,7 @@ def initialize(client, network_hash)
9090
# Cancel the firewall
9191
#
9292
# This method cancels the firewall and releases its
93-
# resources. The cancellation is processed immediately!
93+
# resources. The cancellation is processed immediately!
9494
# Call this method with careful deliberation!
9595
#
9696
# Notes is a string that describes the reason for the
@@ -121,13 +121,18 @@ def cancel!(notes = nil)
121121
# hashes should be entries from the array returned by
122122
# SoftLayer::ServerFirewall.default_rules_mask_keys
123123
#
124+
# *NOTE!* When changing the rules on the firewall, you must
125+
# pass in a complete set of rules each time. The rules you
126+
# submit will replace the entire ruleset on the destination
127+
# firewall.
128+
#
124129
# *NOTE!* The rules themselves have an "orderValue" property.
125130
# It is this property, and *not* the order that the rules are
126131
# found in the rules_data array, which will determine in which
127132
# order the firewall applies it's rules to incomming traffic.
128133
#
129134
# *NOTE!* Changes to the rules are not applied immediately
130-
# on the server side. Instead, they are enqueued by the
135+
# on the server side. Instead, they are enqueued by the
131136
# firewall update service and updated periodically. A typical
132137
# update will take about one minute to apply, but times may vary
133138
# depending on the system load and other circumstances.
@@ -150,7 +155,7 @@ def change_rules!(rules_data)
150155
# used with careful deliberation.
151156
#
152157
# Note that this routine queues a rule change and rule changes may take
153-
# time to process. The change will probably not take effect immediately
158+
# time to process. The change will probably not take effect immediately.
154159
#
155160
# The two symbols accepted as arguments by this routine are:
156161
# :apply_firewall_rules - The rules of the firewall are applied to traffic. This is the default operating mode of the firewall

lib/softlayer/VLANFirewall.rb

Lines changed: 14 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -9,10 +9,10 @@ module SoftLayer
99
# all the servers on a VLAN in the SoftLayer Environment. It is
1010
# also known as a "Dedicated Firewall" in some documentation.
1111
#
12-
# Instances of this class are a bit odd because they actually represent
13-
# VLANs (the VLAN protected by the firewall) and not the physical hardware
14-
# implementing the firewall itself. (although the device is accessible as
15-
# the "networkVlanFirewall" property)
12+
# Instances of this class are a bit odd because they actually represent a
13+
# VLAN (the VLAN protected by the firewall to be specific), and not the
14+
# physical hardware implementing the firewall itself. (although the device
15+
# is accessible as the "networkVlanFirewall" property)
1616
#
1717
# As a result, instances of this class correspond to certain instances
1818
# in the SoftLayer_Network_Vlan service.
@@ -23,7 +23,7 @@ class VLANFirewall < SoftLayer::ModelBase
2323
##
2424
#:attr_reader:
2525
#
26-
# The number of the VLAN protected by this firewall
26+
# The number of the VLAN protected by this firewall.
2727
#
2828
sl_attr :VLAN_number, 'vlanNumber'
2929

@@ -81,12 +81,12 @@ def high_availability?
8181
# Cancel the firewall
8282
#
8383
# This method cancels the firewall and releases its
84-
# resources. The cancellation is processed immediately!
84+
# resources. The cancellation is processed immediately!
8585
# Call this method with careful deliberation!
8686
#
8787
# Notes is a string that describes the reason for the
8888
# cancellation. If empty or nil, a default string will
89-
# be added
89+
# be added.
9090
#
9191
def cancel!(notes = nil)
9292
user = self.softlayer_client[:Account].object_mask("mask[id,account.id]").getCurrentUser
@@ -112,10 +112,15 @@ def cancel!(notes = nil)
112112
# hashes should be entries from the array returned by
113113
# SoftLayer::ServerFirewall.default_rules_mask_keys
114114
#
115+
# *NOTE!* When changing the rules on the firewall, you must
116+
# pass in a complete set of rules each time. The rules you
117+
# submit will replace the entire ruleset on the destination
118+
# firewall.
119+
#
115120
# *NOTE!* The rules themselves have an "orderValue" property.
116121
# It is this property, and *not* the order that the rules are
117122
# found in the rules_data array, which will determine in which
118-
# order the firewall applies it's rules to incomming traffic.
123+
# order the firewall applies its rules to incomming traffic.
119124
#
120125
# *NOTE!* Changes to the rules are not applied immediately
121126
# on the server side. Instead, they are enqueued by the
@@ -141,7 +146,7 @@ def change_rules!(rules_data)
141146
# used with extreme discretion.
142147
#
143148
# Note that this routine queues a rule change and rule changes may take
144-
# time to process. The change will probably not take effect immediately
149+
# time to process. The change will probably not take effect immediately.
145150
#
146151
# The two symbols accepted as arguments by this routine are:
147152
# :apply_firewall_rules - The rules of the firewall are applied to traffic. This is the default operating mode of the firewall

0 commit comments

Comments
 (0)