diff options
| author | Domen Kožar <domen@enlambda.com> | 2017-02-20T14·31+0100 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2017-02-20T14·31+0100 |
| commit | 5789b692d4b0a74f5804a1dfdb4b1f429ab877ea (patch) | |
| tree | 6a61b32327a2780332585c7c3bf56a2a0d76b447 | |
| parent | 302386f775eea309679654e5ea7c972fb6e7b9af (diff) | |
| parent | b8564987a3d9455ee779ca1dd63b1dc9f8ee72d9 (diff) | |
Merge pull request #1240 from lheckemann/tostring-doc
Document toString better
| -rw-r--r-- | doc/manual/expressions/builtins.xml | 16 |
1 files changed, 12 insertions, 4 deletions
diff --git a/doc/manual/expressions/builtins.xml b/doc/manual/expressions/builtins.xml index 063bc04be483..6c38941c01ba 100644 --- a/doc/manual/expressions/builtins.xml +++ b/doc/manual/expressions/builtins.xml @@ -1023,10 +1023,18 @@ in foo</programlisting> <listitem><para>Convert the expression <replaceable>e</replaceable> to a string. - <replaceable>e</replaceable> can be a string (in which case - <function>toString</function> is a no-op), a path (e.g., - <literal>toString /foo/bar</literal> yields - <literal>"/foo/bar"</literal> or a set containing <literal>{ __toString = self: ...; }</literal>.</para></listitem> + <replaceable>e</replaceable> can be: + <itemizedlist> + <listitem>a string (in which case the string is returned unmodified)</listitem> + <listitem>a path (e.g., <literal>toString /foo/bar</literal> yields <literal>"/foo/bar"</literal></listitem> + <listitem>a set containing <literal>{ __toString = self: ...; }</literal></listitem> + <listitem>an integer</listitem> + <listitem>a list, in which case the string representations of its elements are joined with spaces</listitem> + <listitem>a boolean (<literal>false</literal> yields <literal>""</literal>, <literal>true</literal> yields <literal>"1"</literal></listitem> + <listitem><literal>null</literal>, which yields the empty string.</listitem> + </itemizedlist> + </para> + </listitem> </varlistentry> |