Skip to content

Commit 41c74e9

Browse files
committed
Fix ordered list formatting
The rules are similar to those for the unordered lists (see previous commits). Subsequent lines and paragraphs should be aligned to the beginning of the sentence on the first line, like this: 1. This is a list item, it has a second line. Also paragraph. 2. Second list item. code fragment Short, one-sentence items that can be read as part of the surrounding paragraph can start with a non-capital letter
1 parent e0f5dd5 commit 41c74e9

File tree

7 files changed

+56
-53
lines changed

7 files changed

+56
-53
lines changed

lib/eex/lib/eex.ex

Lines changed: 14 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -14,20 +14,20 @@ defmodule EEx do
1414
1515
This module provides 3 main APIs for you to use:
1616
17-
1) Evaluate a string (`eval_string`) or a file (`eval_file`)
18-
directly. This is the simplest API to use but also the
19-
slowest, since the code is evaluated and not compiled before;
20-
21-
2) Define a function from a string (`function_from_string`)
22-
or a file (`function_from_file`). This allows you to embed
23-
the template as a function inside a module which will then
24-
be compiled. This is the preferred API if you have access
25-
to the template at compilation time;
26-
27-
3) Compile a string (`compile_string`) or a file (`compile_file`)
28-
into Elixir syntax tree. This is the API used by both functions
29-
above and is available to you if you want to provide your own
30-
ways of handling the compiled template.
17+
1. Evaluate a string (`eval_string`) or a file (`eval_file`)
18+
directly. This is the simplest API to use but also the
19+
slowest, since the code is evaluated and not compiled before.
20+
21+
2. Define a function from a string (`function_from_string`)
22+
or a file (`function_from_file`). This allows you to embed
23+
the template as a function inside a module which will then
24+
be compiled. This is the preferred API if you have access
25+
to the template at compilation time.
26+
27+
3. Compile a string (`compile_string`) or a file (`compile_file`)
28+
into Elixir syntax tree. This is the API used by both functions
29+
above and is available to you if you want to provide your own
30+
ways of handling the compiled template.
3131
3232
## Options
3333

lib/elixir/lib/kernel/special_forms.ex

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1327,21 +1327,21 @@ defmodule Kernel.SpecialForms do
13271327
13281328
On the other hand, aliases holds some properties:
13291329
1330-
1) The head element of aliases can be any term;
1330+
1. The head element of aliases can be any term.
13311331
1332-
2) The tail elements of aliases are guaranteed to always be atoms;
1332+
2. The tail elements of aliases are guaranteed to always be atoms.
13331333
1334-
3) When the head element of aliases is the atom `:Elixir`, no expansion happen;
1334+
3. When the head element of aliases is the atom `:Elixir`, no expansion happen.
13351335
1336-
4) When the head element of aliases is not an atom, it is expanded at runtime:
1336+
4. When the head element of aliases is not an atom, it is expanded at runtime:
13371337
1338-
quote do: some_var.Foo
1339-
{:__aliases__, [], [{:some_var, [], Elixir}, :Foo]}
1338+
quote do: some_var.Foo
1339+
{:__aliases__, [], [{:some_var, [], Elixir}, :Foo]}
13401340
1341-
Since `some_var` is not available at compilation time, the compiler
1342-
expands such expression to:
1341+
Since `some_var` is not available at compilation time, the compiler
1342+
expands such expression to:
13431343
1344-
Module.concat [some_var, Foo]
1344+
Module.concat [some_var, Foo]
13451345
13461346
"""
13471347
defmacro __aliases__(args)

lib/elixir/lib/process.ex

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -76,18 +76,18 @@ defmodule Process do
7676
7777
The following behaviour applies if reason is any term except `:normal` or `:kill`:
7878
79-
1) If pid is not trapping exits, pid will exit with the given reason;
79+
1. If pid is not trapping exits, pid will exit with the given reason.
8080
81-
2) If pid is trapping exits, the exit signal is transformed into a message
82-
{:EXIT, from, reason} and delivered to the message queue of pid;
81+
2. If pid is trapping exits, the exit signal is transformed into a message
82+
{:EXIT, from, reason} and delivered to the message queue of pid.
8383
84-
3) If reason is the atom `:normal`, pid will not exit. If it is trapping exits,
85-
the exit signal is transformed into a message {:EXIT, from, :normal} and
86-
delivered to its message queue;
84+
3. If reason is the atom `:normal`, pid will not exit. If it is trapping
85+
exits, the exit signal is transformed into a message {:EXIT, from,
86+
:normal} and delivered to its message queue.
8787
88-
4) If reason is the atom `:kill`, that is if `exit(pid, :kill)` is called, an
89-
untrappable exit signal is sent to pid which will unconditionally exit with
90-
exit reason `:killed`.
88+
4. If reason is the atom `:kill`, that is if `exit(pid, :kill)` is called,
89+
an untrappable exit signal is sent to pid which will unconditionally
90+
exit with exit reason `:killed`.
9191
9292
Inlined by the compiler.
9393

lib/elixir/lib/record.ex

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -14,8 +14,8 @@ defmodule Record do
1414
1515
In Elixir, records are used mostly in two situations:
1616
17-
1. To work with short, internal data;
18-
2. To interface with Erlang records;
17+
1. to work with short, internal data
18+
2. to interface with Erlang records
1919
2020
The macros `defrecord/3` and `defrecordp/3` can be used to create
2121
records while `extract/2` can be used to extract records from Erlang

lib/elixir/lib/supervisor/spec.ex

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -40,15 +40,15 @@ defmodule Supervisor.Spec do
4040
4141
Explicit supervisors as above are required when there is a need to:
4242
43-
1. partialy change the supervision tree during hot-code swaps;
43+
1. Partialy change the supervision tree during hot-code swaps.
4444
45-
2. define supervisors inside other supervisors;
45+
2. Define supervisors inside other supervisors.
4646
47-
3. perform actions inside the supervision `init/1` callback.
47+
3. Perform actions inside the supervision `init/1` callback.
4848
49-
For example, you may want to start an ETS table that is linked to
50-
the supervisor (i.e. if the supervision tree needs to be restarted,
51-
the ETS table must be restarted too);
49+
For example, you may want to start an ETS table that is linked to
50+
the supervisor (i.e. if the supervision tree needs to be restarted,
51+
the ETS table must be restarted too).
5252
5353
## Supervisor and worker options
5454

lib/elixir/lib/system.ex

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -153,11 +153,11 @@ defmodule System do
153153
Returns a writable temporary directory.
154154
Searches for directories in the following order:
155155
156-
1. The directory named by the TMPDIR environment variable
157-
2. The directory named by the TEMP environment variable
158-
3. The directory named by the TMP environment variable
159-
4. `C:\TMP` on Windows or `/tmp` on Unix
160-
5. As a last resort, the current working directory
156+
1. the directory named by the TMPDIR environment variable
157+
2. the directory named by the TEMP environment variable
158+
3. the directory named by the TMP environment variable
159+
4. `C:\TMP` on Windows or `/tmp` on Unix
160+
5. as a last resort, the current working directory
161161
162162
Returns `nil` if none of the above are writable.
163163
"""

lib/mix/lib/mix/compilers/erlang.ex

Lines changed: 11 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -24,14 +24,17 @@ defmodule Mix.Compilers.Erlang do
2424
2525
The command above will:
2626
27-
1. Look for files ending with the `lfe` extension in `src`
28-
and their `beam` counterpart in `ebin`;
29-
2. For each stale file (or for all if `force` is true),
30-
invoke the callback passing the calculated input
31-
and output;
32-
3. Update the manifest with the newly compiled outputs;
33-
4. Remove any output in the manifest that that does not
34-
have an equivalent source;
27+
1. look for files ending with the `lfe` extension in `src`
28+
and their `beam` counterpart in `ebin`
29+
30+
2. for each stale file (or for all if `force` is true),
31+
invoke the callback passing the calculated input
32+
and output
33+
34+
3. update the manifest with the newly compiled outputs
35+
36+
4. remove any output in the manifest that that does not
37+
have an equivalent source
3538
3639
The callback must return `{:ok, mod}` or `:error` in case
3740
of error. An error is raised at the end if any of the

0 commit comments

Comments
 (0)