summaryrefslogtreecommitdiff
path: root/lib/stdlib/test/shell_docs_SUITE_data/unknown_erlang_list_to_atom_1_func.txt
blob: c77d5233d46cb339cba2a082c69c141ff86c3337 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25

  -spec list_to_atom(String) -> atom() when String :: string().

  Returns the atom whose text representation is String.

  As from Erlang/OTP 20, String may contain any Unicode character.
  Earlier versions allowed only ISO-latin-1 characters as the
  implementation did not allow Unicode characters above 255.

  Note:
    The number of characters that are permitted in an atom name is
    limited. The default limits can be found in the efficiency
    guide (section Advanced).

  Note:
    There is configurable limit on how many atoms that can exist
    and atoms are not garbage collected. Therefore, it is
    recommended to consider if list_to_existing_atom/1 is a
    better option than list_to_atom/1. The default limits can be
    found in the efficiency guide (section Advanced).

  Example:

    > list_to_atom("Erlang").
    'Erlang'