Skip to content

Commit 1b9287c

Browse files
author
José Valim
committed
Link to writing documentation page
1 parent 1f6c2f2 commit 1b9287c

File tree

1 file changed

+2
-2
lines changed

1 file changed

+2
-2
lines changed

Diff for: getting-started/module-attributes.markdown

+2-2
Original file line numberDiff line numberDiff line change
@@ -34,7 +34,7 @@ Elixir has a handful of reserved attributes. Here are just a few of them, the mo
3434
* `@behaviour` - (notice the British spelling) used for specifying an <abbr title="Open Telecom Platform">OTP</abbr> or user-defined behaviour.
3535
* `@before_compile` - provides a hook that will be invoked before the module is compiled. This makes it possible to inject functions inside the module exactly before compilation.
3636

37-
`@moduledoc` and `@doc` are by far the most used attributes, and we expect you to use them a lot. Elixir treats documentation as first-class and provides many functions to access documentation.
37+
`@moduledoc` and `@doc` are by far the most used attributes, and we expect you to use them a lot. Elixir treats documentation as first-class and provides many functions to access documentation. You can read more about [writing documentation in Elixir in our official documentation](/docs/stable/elixir/typespecs.html).
3838

3939
Let's go back to the `Math` module defined in the previous chapters, add some documentation and save it to the `math.ex` file:
4040

@@ -73,7 +73,7 @@ iex> h Math.sum # Access the docs for the sum function
7373

7474
We also provide a tool called [ExDoc](https://github.com/elixir-lang/ex_doc) which is used to generate HTML pages from the documentation.
7575

76-
You can take a look at the docs for [Module](/docs/stable/elixir/Module.html) for a complete list of supported attributes. Elixir also uses attributes to define [typespecs](/docs/stable/elixir/typespecs.html).
76+
You can take a look at the docs for [Module](/docs/stable/elixir/Module.html) for a complete list of supported attributes. Elixir also uses attributes to define [typespecs](/getting-started/typespecs-and-behaviours.html).
7777

7878
This section covers built-in attributes. However, attributes can also be used by developers or extended by libraries to support custom behaviour.
7979

0 commit comments

Comments
 (0)