Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

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

Open
deadtrickster opened this issue Apr 27, 2021 · 2 comments
Open

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

deadtrickster opened this issue Apr 27, 2021 · 2 comments

Comments

@deadtrickster
Copy link

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 😅

@ferd
Copy link
Member

ferd commented Apr 27, 2021

the doc is probably outdated.

@starbelly
Copy link
Member

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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

3 participants