Hex should follow ExDoc's convention and use `project.name` if ` project.package.name` is not set. A great area for contribution :)
On Tue, Apr 18, 2017 at 11:57 AM, José Valim < [email protected]> wrote: > The reason we moved :name up to project.name is exactly so it can be used > by multiple entities such as Hex and ExDoc. So my suggestion is to read the > :name from the root if project.package.name is not available. > > > > *José Valim* > www.plataformatec.com.br > Skype: jv.ptec > Founder and Director of R&D > > On Mon, Apr 17, 2017 at 5:30 PM, <[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/ms >> gid/elixir-lang-core/11585076-b9ca-48c6-bd5e-ed1eae50cae7% >> 40googlegroups.com >> <https://groups.google.com/d/msgid/elixir-lang-core/11585076-b9ca-48c6-bd5e-ed1eae50cae7%40googlegroups.com?utm_medium=email&utm_source=footer> >> . >> For more options, visit https://groups.google.com/d/optout. >> > > -- > 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/CAGnRm4JZFLz1tjkE7fm7%3D9% > 3DeQJQwcnFMHaV_H1w9xwWt_hH6EQ%40mail.gmail.com > <https://groups.google.com/d/msgid/elixir-lang-core/CAGnRm4JZFLz1tjkE7fm7%3D9%3DeQJQwcnFMHaV_H1w9xwWt_hH6EQ%40mail.gmail.com?utm_medium=email&utm_source=footer> > . > > For more options, visit https://groups.google.com/d/optout. > -- Eric Meadows-Jönsson -- 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/CAM_eapiDPjL6mUWMMstxAEzMp3O46T2y8X0O2uZ0LBW%3DXDfgag%40mail.gmail.com. For more options, visit https://groups.google.com/d/optout.
