Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update attributes in EEP 48 #8945

Merged
merged 2 commits into from
Oct 21, 2024
Merged
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 10 additions & 4 deletions lib/kernel/doc/guides/eep48_chapter.md
Original file line number Diff line number Diff line change
Expand Up @@ -105,8 +105,8 @@ For each entry in Docs, we have:
`callback`. Other languages will add their own. For instance, Elixir and LFE
might add `macro`.

- **`Anno`** - annotation (line, column, file) of the module documentation or of
the definition itself (see `m:erl_anno`).
- **`Anno`** - annotation (line, column, file) of the module documentation
(see `m:erl_anno`).

- **`Signature`** - the signature of the entity. It is is a list of binaries.
Each entry represents a binary in the signature that can be joined with
Expand Down Expand Up @@ -134,6 +134,9 @@ information to each entry. This EEP documents the following metadata keys:

- **`authors := [binary()]`** - a list of authors as binaries.

- **`behaviours := [module()]`** - a list of the behaviours implemented by
this module.

- **`cross_references := [module() | {module(), {Kind, Name, Arity}}]`** - a
list of modules or module entries that can be used as cross references when
generating documentation.
Expand All @@ -145,8 +148,11 @@ information to each entry. This EEP documents the following metadata keys:
- **`since := binary()`** - a binary representing the version such entry was
added, such as `<<"1.3.0">>` or `<<"20.0">>`.

- **`edit_url := binary()`** - a binary representing a URL to change the
documentation itself.
- **`source := binary()`** - the location of the source file for this module.
Applies only to the module metadata.

- **`source_anno := erl_anno:anno()`** - annotation metadata of the source
code (opposite to the annotation of the documentation attribute).

Any key may be added to Metadata at any time. Keys that are frequently used by
the community can be standardized in future versions.
Expand Down
Loading