Skip to content

Commit 843f148

Browse files
sn0wfa11Brent Cook
authored andcommitted
One more yard doc function
1 parent e84765c commit 843f148

File tree

1 file changed

+4
-0
lines changed

1 file changed

+4
-0
lines changed

modules/post/multi/manage/autoroute.rb

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -34,13 +34,17 @@ def initialize(info={})
3434
])
3535
end
3636

37+
# Get the CMD string vs ACTION
38+
#
3739
# Backwards compatability: This was changed because the option name of "ACTION"
3840
# is special for some things, and indicates the :action attribute, not a datastore option.
3941
# However, this is a semi-popular module, though, so I'd prefer not to break people's
4042
# RC scripts that set ACTION. Note that ACTION is preferred over CMD.
4143
#
4244
# TODO: The better solution is to use 'Action' and 'DefaultAction' info elements,
4345
# but there are some squirelly problems right now with rendering these for post modules.
46+
#
47+
# @return [string class] cmd string
4448
def route_cmd
4549
if datastore['ACTION'].to_s.empty?
4650
datastore['CMD'].to_s.downcase.to_sym

0 commit comments

Comments
 (0)