search

erlef / documentation-wg

EEF Documentation Working Group
9 stars 1 forks source link

EEP 48: Provide a distinction between code source and documentation source #1

Closed josevalim closed 4 years ago

josevalim commented 5 years ago

Today, EEP has an Anno field for each entry, which is documented as follows:

Anno - annotation (line, column, file) of the module documentation or of the definition itself (see erl_anno)

The issue, however, is that Erlang has distinct locations for documentation and source code. In order to not introduce a breaking change to EEP 48, I propose:

  1. Enforce Anno to be about the source code
  2. Introduce an edit_url metadata field that contains the URL for editing the documentation
garazdawi commented 4 years ago

Sounds good to me. I added edit_url metadata to my branch in #3.

josevalim commented 4 years ago

Perfect. We will keep this open as we need to support it on ExDoc too!

josevalim commented 4 years ago

PR sent to update EEP 48: https://github.com/erlang/eep/pull/9