Skip to content

Commit

Permalink
Fix docs link
Browse files Browse the repository at this point in the history
Related to #13284.
  • Loading branch information
josevalim committed Jan 27, 2024
1 parent ad778a6 commit da0189e
Show file tree
Hide file tree
Showing 12 changed files with 11 additions and 11 deletions.
1 change: 0 additions & 1 deletion Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -189,7 +189,6 @@ docs_elixir: compile ../ex_doc/bin/ex_doc
$(Q) rm -rf doc/elixir
$(call DOCS_COMPILE,Elixir,elixir,Kernel,--config "lib/elixir/scripts/elixir_docs.exs")
$(call DOCS_CONFIG,elixir)
cp -R lib/elixir/pages/images doc/elixir

docs_eex: compile ../ex_doc/bin/ex_doc
@ echo "==> ex_doc (eex)"
Expand Down
2 changes: 1 addition & 1 deletion lib/elixir/lib/enum.ex
Original file line number Diff line number Diff line change
Expand Up @@ -261,7 +261,7 @@ defmodule Enum do
traversed as if it was an enumerable.
For a general overview of all functions in the `Enum` module, see
[the `Enum` cheatsheet](enum-cheat.html).
[the `Enum` cheatsheet](enum-cheat.cheatmd).
The functions in this module work in linear time. This means that, the
time it takes to perform an operation grows at the same rate as the length
Expand Down
2 changes: 1 addition & 1 deletion lib/elixir/pages/anti-patterns/design-anti-patterns.md
Original file line number Diff line number Diff line change
Expand Up @@ -167,7 +167,7 @@ defmodule MyModule do
end
```

This is only possible because the `File` module provides APIs for reading files with tuples as results (`File.read/1`), as well as a version that raises an exception (`File.read!/1`). The bang (exclamation point) is effectively part of [Elixir's naming conventions](naming-conventions.html#trailing-bang-foo).
This is only possible because the `File` module provides APIs for reading files with tuples as results (`File.read/1`), as well as a version that raises an exception (`File.read!/1`). The bang (exclamation point) is effectively part of [Elixir's naming conventions](naming-conventions.md#trailing-bang-foo).

Library authors are encouraged to follow the same practices. In practice, the bang variant is implemented on top of the non-raising version of the code. For example, `File.read!/1` is implemented as:

Expand Down
2 changes: 1 addition & 1 deletion lib/elixir/pages/getting-started/basic-types.md
Original file line number Diff line number Diff line change
Expand Up @@ -325,6 +325,6 @@ iex> 1 === 1.0
false
```

The comparison operators in Elixir can compare across any data type. We say these operators perform _structural comparison_. For more information, you can read our documentation on [Structural vs Semantic comparisons](Kernel.html#module-structural-comparison).
The comparison operators in Elixir can compare across any data type. We say these operators perform _structural comparison_. For more information, you can read our documentation on [Structural vs Semantic comparisons](`Kernel#module-structural-comparison`).

Elixir also provides data-types for expressing collections, such as lists and tuples, which we learn next. When we talk about concurrency and fault-tolerance via processes, we will also discuss ports, pids, and references, but that will come on later chapters. Let's move forward.
2 changes: 1 addition & 1 deletion lib/elixir/pages/getting-started/enumerable-and-streams.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ iex> Enum.map(%{1 => 2, 3 => 4}, fn {k, v} -> k * v end)
[2, 12]
```

The `Enum` module provides a huge range of functions to transform, sort, group, filter and retrieve items from enumerables. It is one of the modules developers use frequently in their Elixir code. For a general overview of all functions in the `Enum` module, see [the `Enum` cheatsheet](enum-cheat.html).
The `Enum` module provides a huge range of functions to transform, sort, group, filter and retrieve items from enumerables. It is one of the modules developers use frequently in their Elixir code. For a general overview of all functions in the `Enum` module, see [the `Enum` cheatsheet](enum-cheat.cheatmd).

Elixir also provides ranges (see `Range`), which are also enumerable:

Expand Down
2 changes: 1 addition & 1 deletion lib/elixir/pages/meta-programming/macros.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ defmodule Unless do
end
```

The function receives the arguments and passes them to `if/2`. However, as we learned in the [previous guide](quote-and-unquote.html), the macro will receive quoted expressions, inject them into the quote, and finally return another quoted expression.
The function receives the arguments and passes them to `if/2`. However, as we learned in the [previous guide](quote-and-unquote.md), the macro will receive quoted expressions, inject them into the quote, and finally return another quoted expression.

Let's start `iex` with the module above:

Expand Down
2 changes: 1 addition & 1 deletion lib/elixir/pages/mix-and-otp/dynamic-supervisor.md
Original file line number Diff line number Diff line change
Expand Up @@ -183,7 +183,7 @@ A GUI should pop up containing all sorts of information about our system, from g
In the Applications tab, you will see all applications currently running in your system alongside their supervision tree. You can select the `kv` application to explore it further:
<img src="images/kv-observer.png" alt="Observer GUI screenshot" />
<img src="assets/kv-observer.png" alt="Observer GUI screenshot" />
Not only that, as you create new buckets on the terminal, you should see new processes spawned in the supervision tree shown in Observer:
Expand Down
2 changes: 1 addition & 1 deletion lib/elixir/pages/references/operators.md
Original file line number Diff line number Diff line change
Expand Up @@ -64,7 +64,7 @@ Finally, these operators appear in the precedence table above but are only meani
* `=>` - see [`%{}`](`%{}/1`)
* `when` - see [Guards](patterns-and-guards.md#guards)
* `<-` - see [`for`](`for/1`) and [`with`](`with/1`)
* `\\` - see [Default arguments](Kernel.html#def/2-default-arguments)
* `\\` - see [Default arguments](`Kernel#def/2-default-arguments`)

## Comparison operators

Expand Down
2 changes: 1 addition & 1 deletion lib/elixir/pages/references/patterns-and-guards.md
Original file line number Diff line number Diff line change
Expand Up @@ -274,7 +274,7 @@ Not all expressions are allowed in guard clauses, but only a handful of them. Th

### List of allowed functions and operators

You can find the built-in list of guards [in the `Kernel` module](Kernel.html#guards). Here is an overview:
You can find the built-in list of guards [in the `Kernel` module](`Kernel#guards`). Here is an overview:

* comparison operators ([`==`](`==/2`), [`!=`](`!=/2`), [`===`](`===/2`), [`!==`](`!==/2`),
[`<`](`</2`), [`<=`](`<=/2`), [`>`](`>/2`), [`>=`](`>=/2`))
Expand Down
2 changes: 1 addition & 1 deletion lib/elixir/pages/references/typespecs.md
Original file line number Diff line number Diff line change
Expand Up @@ -321,7 +321,7 @@ end
```

This code generates a warning letting you know that you are mistakenly implementing `parse/0` instead of `parse/1`.
You can read more about `@impl` in the [module documentation](Module.html#module-impl).
You can read more about `@impl` in the [module documentation](`Module#module-impl`).

### Using behaviours

Expand Down
2 changes: 1 addition & 1 deletion lib/elixir/pages/references/unicode-syntax.md
Original file line number Diff line number Diff line change
Expand Up @@ -81,7 +81,7 @@ Unicode atoms in Elixir follow the identifier rule above with the following modi
* `<Start>` additionally includes the code point `_` (005F)
* `<Continue>` additionally includes the code point `@` (0040)

Note atoms can also be quoted, which allows any characters, such as `:"hello elixir"`. All Elixir operators are also valid atoms, such as `:+`, `:@`, `:|>`, and others. The full description of valid atoms is available in the ["Atoms" section in the syntax reference](syntax-reference.html#atoms).
Note atoms can also be quoted, which allows any characters, such as `:"hello elixir"`. All Elixir operators are also valid atoms, such as `:+`, `:@`, `:|>`, and others. The full description of valid atoms is available in the ["Atoms" section in the syntax reference](syntax-reference.md#atoms).

#### Variables, local calls, and remote calls

Expand Down
1 change: 1 addition & 0 deletions lib/elixir/scripts/elixir_docs.exs
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@
canonical = System.fetch_env!("CANONICAL")

[
assets: "lib/elixir/pages/images",
extras: [
"lib/elixir/pages/getting-started/introduction.md",
"lib/elixir/pages/getting-started/basic-types.md",
Expand Down

0 comments on commit da0189e

Please sign in to comment.