Skip to content

Commit 05f5073

Browse files
author
José Valim
committed
Clarify that any metadata is accepted, only some are shown
1 parent 18d96c2 commit 05f5073

File tree

1 file changed

+3
-3
lines changed

1 file changed

+3
-3
lines changed

CHANGELOG.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -11,11 +11,11 @@ Elixir v1.7 implements [EEP 48](http://erlang.org/eep/eeps/eep-0048.html). EEP 4
1111
@moduledoc authors: ["Jane", "Mary"], since: "1.4.0"
1212
```
1313

14-
Currently Elixir supports two metadata keys: `:deprecated` and `:since`. Other keys will be added in the future. Passing metadata is supported on `@doc`, `@moduledoc` and `@typedoc`.
14+
Passing metadata is supported on `@doc`, `@moduledoc` and `@typedoc`.
1515

16-
To access the new documentation, developers should use `Code.fetch_docs/1`. The old documentation format is no longer available and the old `Code.get_docs/1` function will return `nil` accordingly.
16+
To access the new documentation format, developers should use `Code.fetch_docs/1`. The old documentation format is no longer available and the old `Code.get_docs/1` function will return `nil` accordingly.
1717

18-
Tools like IEx and ExDoc have been updated to leverage the new format and show relevant metadata to users.
18+
Tools like IEx and ExDoc have been updated to leverage the new format and show relevant metadata to users. While Elixir allows any metadata to be given, those tools currently exhibit only `:deprecated` and `:since`. Other keys may be shown in the future.
1919

2020
## The `__STACKTRACE__` construct
2121

0 commit comments

Comments
 (0)