search

erlef / rebar3_hex

Rebar3 Hex library
Apache License 2.0
101 stars 49 forks source link

Code and hex.pm docs don't agree on "description" property. #224

Open deadtrickster opened 3 years ago

deadtrickster commented 3 years ago

The code mandates presence of "description" property.

quantile_estimator.app.src : missing or empty description property

hex.pm docs says this (https://hex.pm/docs/rebar3_publish):

Then fill in the description property. It should be a sentence, or a few sentences, describing the package. The description is optional but highly recommended.

I'm confused :sweat_smile:

ferd commented 3 years ago

the doc is probably outdated.

starbelly commented 3 years ago

Confirming that, but we do need to make a change per what hexpm actually does : https://github.com/hexpm/hexpm/blob/952cbe30386a834c0ae758910766a5fa98f95316/lib/hexpm/repository/package_metadata.ex#L20

If the package is public, then and only then is description is required. I'll open a ticket for this.