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

Mention block form of Struct.new in Style/StructInheritance #6875

Merged
merged 3 commits into from Apr 4, 2019

Conversation

XrXr
Copy link
Contributor

@XrXr XrXr commented Apr 1, 2019

As the documentation for Struct recommends using the block
form over inheriting, I think it is worth mentioning it.

If a block is given it will be evaluated in the context of
StructClass, passing the created class as a parameter

This is the recommended way to customize a struct.

Adjust examples in the documentation and add a test which uses
the block form.


Before submitting the PR make sure the following are checked:

  • Wrote good commit messages.
  • Commit message starts with [Fix #issue-number] (if the related issue exists).
  • Feature branch is up-to-date with master (if not - rebase it).
  • Squashed related commits together.
  • Added tests.
  • Added an entry to the Changelog if the new code introduces user-observable changes. See changelog entry format.
  • The PR relates to only one subject with a clear title
    and description in grammatically correct, complete sentences.
  • Run bundle exec rake default. It executes all tests and RuboCop for itself, and generates the documentation.

XrXr added 2 commits April 1, 2019 19:06
As the documentation for `Struct` recommends using the block
form over inheriting, I think it is worth mentioning it.

> If a block is given it will be evaluated in the context of
StructClass, passing the created class as a parameter

> This is the recommended way to customize a struct.

Adjust examples in the documentation and add a test which uses
the block form.
@bbatsov bbatsov merged commit 3bcbed1 into rubocop:master Apr 4, 2019
@bbatsov
Copy link
Collaborator

bbatsov commented Apr 4, 2019

Thanks! Probably it's worth extending the rationale of the cop as well.

@XrXr XrXr deleted the struct-message branch April 4, 2019 15:09
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

Successfully merging this pull request may close these issues.

None yet

2 participants