aboutsummaryrefslogtreecommitdiffstats
path: root/lib/stdlib/doc/src/lib.xml
diff options
context:
space:
mode:
authorBjörn Gustavsson <[email protected]>2016-05-18 15:53:35 +0200
committerBjörn Gustavsson <[email protected]>2016-06-13 12:05:57 +0200
commit68d53c01b0b8e9a007a6a30158c19e34b2d2a34e (patch)
tree4613f513b9465beb7febec6c74c8ef0502f861fe /lib/stdlib/doc/src/lib.xml
parent99b379365981e14e2c8dde7b1a337c8ff856bd4a (diff)
downloadotp-68d53c01b0b8e9a007a6a30158c19e34b2d2a34e.tar.gz
otp-68d53c01b0b8e9a007a6a30158c19e34b2d2a34e.tar.bz2
otp-68d53c01b0b8e9a007a6a30158c19e34b2d2a34e.zip
Update STDLIB documentation
Language cleaned up by the technical writers xsipewe and tmanevik from Combitech. Proofreading and corrections by Björn Gustavsson and Hans Bolinder.
Diffstat (limited to 'lib/stdlib/doc/src/lib.xml')
-rw-r--r--lib/stdlib/doc/src/lib.xml57
1 files changed, 31 insertions, 26 deletions
diff --git a/lib/stdlib/doc/src/lib.xml b/lib/stdlib/doc/src/lib.xml
index ac41987eaf..58dad7c9e0 100644
--- a/lib/stdlib/doc/src/lib.xml
+++ b/lib/stdlib/doc/src/lib.xml
@@ -29,68 +29,73 @@
<rev></rev>
</header>
<module>lib</module>
- <modulesummary>A number of useful library functions</modulesummary>
+ <modulesummary>Useful library functions.</modulesummary>
<description>
<warning>
- <p>This module is retained for compatibility. It may disappear
- without warning in a future release.</p>
+ <p>This module is retained for backward compatibility. It can disappear
+ without warning in a future Erlang/OTP release.</p>
</warning>
</description>
+
<funcs>
<func>
- <name name="flush_receive" arity="0"/>
- <fsummary>Flush messages</fsummary>
- <desc>
- <p>Flushes the message buffer of the current process.</p>
- </desc>
- </func>
- <func>
<name name="error_message" arity="2"/>
- <fsummary>Print error message</fsummary>
+ <fsummary>Print error message.</fsummary>
<desc>
<p>Prints error message <c><anno>Args</anno></c> in accordance with
- <c><anno>Format</anno></c>. Similar to <c>io:format/2</c>, see
- <seealso marker="io#fwrite/1">io(3)</seealso>.</p>
+ <c><anno>Format</anno></c>. Similar to
+ <seealso marker="io#format/1"><c>io:format/2</c></seealso>.</p>
</desc>
</func>
+
<func>
- <name name="progname" arity="0"/>
- <fsummary>Return name of Erlang start script</fsummary>
+ <name name="flush_receive" arity="0"/>
+ <fsummary>Flush messages.</fsummary>
<desc>
- <p>Returns the name of the script that started the current
- Erlang session.</p>
+ <p>Flushes the message buffer of the current process.</p>
</desc>
</func>
+
<func>
<name name="nonl" arity="1"/>
- <fsummary>Remove last newline</fsummary>
+ <fsummary>Remove last newline.</fsummary>
<desc>
<p>Removes the last newline character, if any, in
<c><anno>String1</anno></c>.</p>
</desc>
</func>
+
+ <func>
+ <name name="progname" arity="0"/>
+ <fsummary>Return name of Erlang start script.</fsummary>
+ <desc>
+ <p>Returns the name of the script that started the current
+ Erlang session.</p>
+ </desc>
+ </func>
+
<func>
<name name="send" arity="2"/>
- <fsummary>Send a message</fsummary>
+ <fsummary>Send a message.</fsummary>
<desc>
- <p>This function to makes it possible to send a message using
- the <c>apply/3</c> BIF.</p>
+ <p>Makes it possible to send a message using the <c>apply/3</c> BIF.</p>
</desc>
</func>
+
<func>
<name name="sendw" arity="2"/>
- <fsummary>Send a message and wait for an answer</fsummary>
+ <fsummary>Send a message and wait for an answer.</fsummary>
<desc>
- <p>As <c>send/2</c>, but waits for an answer. It is implemented
- as follows:</p>
+ <p>As <seealso marker="#send/2"><c>send/2</c></seealso>,
+ but waits for an answer. It is implemented as follows:</p>
<code type="none">
sendw(To, Msg) ->
To ! {self(),Msg},
receive
Reply -> Reply
end.</code>
- <p>The message returned is not necessarily a reply to the
- message sent.</p>
+ <p>The returned message is not necessarily a reply to the sent
+ message.</p>
</desc>
</func>
</funcs>