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.

Sign up for GitHub

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

Jump to bottom

Add link to style guide into the documentation #3941

Merged
merged 2 commits into from Jan 20, 2017
Merged

Add link to style guide into the documentation #3941

merged 2 commits into from Jan 20, 2017

Conversation

pocke
Copy link
Collaborator

@pocke pocke commented Jan 20, 2017

Currently, the documentation doesn't have link to style guide.

The change adds links to style guide and reference.

Example
1484889524

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).
  • Used the same coding conventions as the rest of the project.
  • 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.
  • All tests are passing.
  • The new code doesn't generate RuboCop offenses.
  • The PR relates to only one subject with a clear title
    and description in grammatically correct, complete sentences.
  • Updated cop documentation with rake generate_cops_documentation (required only when you've added a new cop or changed the configuration/documentation of an existing cop).

bbatsov
bbatsov reviewed Jan 20, 2017
View reviewed changes
manual/cops_lint.md
@@ -25,6 +25,9 @@ do_something *some_array
do_something(*some_array)
```

### References
* [https://github.com/bbatsov/ruby-style-guide#method-invocation-parens](https://github.com/bbatsov/ruby-style-guide#method-invocation-parens)
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Have the code insert a blank line after the section title.

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

👍 I fixed it.

@bbatsov bbatsov merged commit 08217fe into rubocop:master Jan 20, 2017
@bbatsov
Copy link
Collaborator

bbatsov commented Jan 20, 2017

Great work! 👍

@pocke pocke deleted the doc-reference-link branch January 20, 2017 06:12
pocke added a commit to pocke/rubocop that referenced this pull request Jan 31, 2017
@pocke
Add a link to reference for MisinGrouping cop in the documentation
0c0bddb 
Ref

- rubocop#3982
- rubocop#3941
@pocke pocke mentioned this pull request Jan 31, 2017
Merged
bbatsov pushed a commit that referenced this pull request Feb 1, 2017
@pocke @bbatsov
Add a link to reference for MixinGrouping cop in the documentation (#…
2efa94b 
…3993)

Ref

- #3982
- #3941
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@bbatsov bbatsov bbatsov left review comments

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

None yet
2 participants
@pocke @bbatsov