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

improved required/recommended attributes #1046

Merged
merged 3 commits into from Feb 16, 2015

Conversation

mpapis
Copy link
Contributor

@mpapis mpapis commented Oct 12, 2014

according to http://guides.rubygems.org/specification-reference/#description description is not required - removed annoying warning

@mpapis mpapis changed the title do not require description in specification improved required/recommended attributes Oct 12, 2014
@mpapis
Copy link
Contributor Author

mpapis commented Oct 12, 2014

also moved email and hompage to recommended so the docs at http://guides.rubygems.org/specification-reference/ match https://github.com/rubygems/rubygems/pull/1046/files#diff-05477d38d75c98664b0e7dec6eb73b45L2604:

%w[author email homepage summary].each do |attribute|
  value = self.send attribute
  warning "no #{attribute} specified" if value.nil? or value.empty?
end

(yes the docs will require refresh)

@drbrain
Copy link
Member

drbrain commented Oct 13, 2014

I can't remember if the warning or the documentation came first, did you check? I'd rather resolve this based on history than deferring to the documentation.

@mpapis
Copy link
Contributor Author

mpapis commented Oct 13, 2014

actually I based it on my experience with rubygems ;) requiring both description + summary and not allowing them to be the same is just pointless, I either get missing or duplicate warning, and it's true for all my gems, I do not have a big description, usually the single line summary tells basic story and more detailed explanation might take pages in README.md

@drbrain drbrain added this to the 2.5 milestone Nov 30, 2014
zzak pushed a commit that referenced this pull request Feb 16, 2015
Gem::Specification#description is no longer a required attribute
@zzak zzak merged commit a7ee2c4 into rubygems:master Feb 16, 2015
zzak pushed a commit that referenced this pull request Feb 16, 2015
@mpapis mpapis deleted the feature/do_not_require_description branch February 17, 2015 00:02
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants