puck/lix
0
0
Fork 0
forked from lix-project/lix
Code Pull requests Activity

Merge pull request #1240 from lheckemann/tostring-doc

Browse source 
Document toString better
This commit is contained in:
Domen Kožar 2017-02-20 15:31:41 +01:00 committed by GitHub
parent 302386f775 b8564987a3
commit 5789b692d4
1 changed files with 12 additions and 4 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

16
doc/manual/expressions/builtins.xml
View file

@ -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>