Thank you, José and Eric! For posterity, an issue for this was made on the Hex github repository: https://github.com/hexpm/hex/issues/364
On Monday, April 17, 2017 at 5:30:28 PM UTC+2, [email protected] wrote: > > 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 <http://project.name>* and > *project.package.name > <http://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 <http://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 <http://project.package.name>* overrides > *project.name > <http://project.name>* for Hex. > > 2. *project.name <http://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 <http://project.package.name>* overrides > *project.name > <http://project.name>* for Hex. *project.docs.name > <http://project.docs.name>* overrides *project.name <http://project.name>* > for > ExDoc. > > 3. *project.name <http://project.name>* is the proper way. > *project.package.name > <http://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/20494910-f826-435e-acf5-dea2582a2bbe%40googlegroups.com. For more options, visit https://groups.google.com/d/optout.
