Update specification reference required fields and metadata docs#187
Closed
greysteil wants to merge 1 commit into
Closed
Update specification reference required fields and metadata docs#187greysteil wants to merge 1 commit into
greysteil wants to merge 1 commit into
Conversation
This was referenced Jun 22, 2017
Member
|
@greysteil did you use the rubygems master for these changes? I think this repo gets updated only after changes are released. I have been waiting for months 😭 (Unreleased commits on rubygems) |
Author
|
Hmm, I did just use master. Can someone confirm that's the process, and if so whether PRs to update the Specification Reference docs are needed (rather than them being auto-generated)? |
bundlerbot
added a commit
to ruby/rubygems
that referenced
this pull request
Aug 31, 2017
Update specification reference docs # Description: Previously, the Specification Reference [guide](http://guides.rubygems.org/specification-reference/#required-gemspec-attributes) listed incorrect required attributes (as noted in rubygems/guides#121, for example). This PR reorders `lib/rubygems/specification.rb` in order to create a better specification-reference. - Updates the required attributes to be just `name`, `version`, `summary` and `files`, in line with the `@@required_attributes` and `@@default_value` variables. - Cleans up doc consistency by creating a `Recommended gemspec attributes` section, rather than relying on `:category: Recommended gemspec attributes` tags. - Adds a `metadata` hash to the headline example gemspec. Corresponding guides PR is rubygems/guides#187. ______________ # Tasks: - [x] Describe the problem / feature - [x] Write code to solve the problem - [x] Get code review from coworkers / friends I will abide by the [code of conduct](https://github.com/rubygems/rubygems/blob/master/CODE_OF_CONDUCT.md).
Contributor
|
hi. I'll ask around and see if I can figure out what the process is for publishing updates to guides. then maybe I can help resolve all the PRs on this repo. |
Contributor
|
looks like they get pulled in when there's a RubyGems release. |
Contributor
|
closing since this should be handled with the next RubyGems release. thanks for the help, @greysteil. ❤️ |
hsbt
pushed a commit
to ruby/rubygems-server
that referenced
this pull request
Sep 24, 2021
Update specification reference docs # Description: Previously, the Specification Reference [guide](http://guides.rubygems.org/specification-reference/#required-gemspec-attributes) listed incorrect required attributes (as noted in rubygems/guides#121, for example). This PR reorders `lib/rubygems/specification.rb` in order to create a better specification-reference. - Updates the required attributes to be just `name`, `version`, `summary` and `files`, in line with the `@@required_attributes` and `@@default_value` variables. - Cleans up doc consistency by creating a `Recommended gemspec attributes` section, rather than relying on `:category: Recommended gemspec attributes` tags. - Adds a `metadata` hash to the headline example gemspec. Corresponding guides PR is rubygems/guides#187. ______________ # Tasks: - [x] Describe the problem / feature - [x] Write code to solve the problem - [x] Get code review from coworkers / friends I will abide by the [code of conduct](https://github.com/rubygems/rubygems/blob/master/CODE_OF_CONDUCT.md).
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Generated from the changes in ruby/rubygems#1960.
Note: the metadata docs were out-of-date, as changes had been made to
Gem::Specificationpreviously and not pulled in here.