Skip to content
This repository was archived by the owner on Aug 31, 2021. It is now read-only.

Commit 2aa998c

Browse files
Auto-merge pull request #7136 from livecodesam/patch-106
[Bugfix-22278] Correct missing text in log documentation Removed a self reference and added logMessage to the references.
2 parents 8b1db59 + ef82f8f commit 2aa998c

File tree

2 files changed

+12
-10
lines changed

2 files changed

+12
-10
lines changed

docs/dictionary/command/log.lcdoc

Lines changed: 11 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -38,15 +38,16 @@ A comma separated list of expressions containing the arguments to send.
3838
Arrays are expressions and are valid to send as arguments.
3939

4040
Description:
41-
The <log> command invokes the <logMessage> handler. When the <logMessage> is the
42-
default value of `log` then the <log> command behaves in the same way as any
43-
other scripted handler. If the <logMessage> is set to empty then the <log>
44-
command does not invoke any handler or evaluate parameters, therefore, allowing
45-
for many logs to be added to scripts for development and an easy low-cost method
46-
to turn the logging off for a release build. The <logMessage> may be set to any
47-
handler name, however, if the handler is not in the message path then use of the
48-
<log> command will throw a `can't find handler` error.
49-
50-
References: log (command), put (command), msgChanged (message)
41+
The <log> command invokes the handler specified by the <logMessage> property.
42+
When the <logMessage> is the default value of `log` then the <log> command
43+
behaves in the same way as any other scripted handler. If the <logMessage> is
44+
set to empty then the <log> command does not invoke any handler or evaluate
45+
parameters, therefore, allowing for many logs to be added to scripts for
46+
development and an easy low-cost method to turn the logging off for a release
47+
build. The <logMessage> may be set to any handler name, however, if the
48+
handler is not in the message path then use of the <log> command will throw a
49+
`can't find handler` error.
50+
51+
References: put (command), msgChanged (message), logMessage (property)
5152

5253
Tags: debugging

docs/notes/bugfix-22278.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
# Corrected missing text issue in the documentation for the log command

0 commit comments

Comments
 (0)