Recently I found out that ExDoc allows specifying a `:name` field inside 
the `project` implementation that is part of the `mix.exs` file, which will 
be used in the generated documentation.

Interestingly, Hex uses a name that is part of the `:package` subfield.

So we have both *project.name* and *project.package.name*


Having two separate locations to specify the (humanly readable) name seems 
odd.

As these are two external packages but both closely related to elixir's 
core ecosystem, I thought it most appropriate to discuss about this issue 
here.


Ideas to conventionalize:

1. *project.name* is used by ExDoc, Hex and other packages that might 
consume a humanly readable version of the project's name. 
*project.package.name* overrides *project.name* for Hex.

2. *project.name* is used by ExDoc, Hex and other packages that might 
consume a humanly readable version of the project's name. 
*project.package.name* overrides *project.name* for Hex. *project.docs.name* 
overrides 
*project.name* for ExDoc.

3. *project.name* is the proper way. *project.package.name* is considered 
deprecated.


What to do?

~Qqwy

-- 
You received this message because you are subscribed to the Google Groups 
"elixir-lang-core" group.
To unsubscribe from this group and stop receiving emails from it, send an email 
to [email protected].
To view this discussion on the web visit 
https://groups.google.com/d/msgid/elixir-lang-core/11585076-b9ca-48c6-bd5e-ed1eae50cae7%40googlegroups.com.
For more options, visit https://groups.google.com/d/optout.

Reply via email to