Move authors assigner to required attributes section of Gem::Specification #2406
Conversation
This file contains 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
deivid-rodriguez
approved these changes
Sep 25, 2018
bronzdoc
approved these changes
Sep 25, 2018
|
@bundlerbot r+ |
ghost
pushed a commit
that referenced
this pull request
Sep 25, 2018
2406: Move authors assigner to required attributes section of Gem::Specification r=bronzdoc a=greysteil Currently, the [gem specification docs](https://guides.rubygems.org/specification-reference/) suggest that author / authors is a "recommended" attribute. In fact, [author / authors is a required attribute](https://github.com/rubygems/rubygems/blob/master/lib/rubygems/specification_policy.rb#L287-L291). This PR is a code move that puts the `authors` assignment method into the required attributes section (and updates its description to explain that specifying `author` is an alternative). This should make the docs much clearer next time they're generated. Co-authored-by: Grey Baker <greysteil@gmail.com>
Build succeeded |
ghost
merged commit
This pull request was closed.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Currently, the gem specification docs suggest that author / authors is a "recommended" attribute.
In fact, author / authors is a required attribute.
This PR is a code move that puts the
authorsassignment method into the required attributes section (and updates its description to explain that specifyingauthoris an alternative). This should make the docs much clearer next time they're generated.