add an easy way to find yard plugins #1143
Merged
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
lsegal
reviewed
Nov 20, 2017
docs/GettingStarted.md
Outdated
| @@ -669,6 +669,8 @@ To disable a plugin create the file `~/.yard/ignored_plugins` with a list | |||
| of plugin names separated by newlines. Note that the `.yard` directory might | |||
| not exist, so you may need to create it. | |||
|
|
|||
| You may find some useful YARD plugins on [RubyGems](https://rubygems.org/search?utf8=%E2%9C%93&query=name%3A+yard) or with a [Google avanced querry](https://www.google.com/search?q=site%3Arubygems.org+intitle%3A%22yard-%22+OR+intitle%3A%22yard_%22). | |||
There was a problem hiding this comment.
typo: querry -> query
also nitpick but consider trying to enforce an 80char line width here. You can use the [RubyGems][rubygems] linking format with the references just below.
There was a problem hiding this comment.
- my bad for the typo
- I wanted to but forget about the line of 80 chars
lsegal
requested changes
Nov 21, 2017
docs/GettingStarted.md
Outdated
| @@ -669,8 +669,11 @@ To disable a plugin create the file `~/.yard/ignored_plugins` with a list | |||
| of plugin names separated by newlines. Note that the `.yard` directory might | |||
| not exist, so you may need to create it. | |||
|
|
|||
| You may find some useful YARD plugins on [RubyGems](https://rubygems.org/search?utf8=%E2%9C%93&query=name%3A+yard) or with a [Google avanced querry](https://www.google.com/search?q=site%3Arubygems.org+intitle%3A%22yard-%22+OR+intitle%3A%22yard_%22). | |||
| You may find some useful YARD plugins on [RubyGems][RubyGemsQuery] or with | |||
| a [Google avanced query][GoogleAdvancedQuery]. | |||
There was a problem hiding this comment.
oops, another typo: avanced -> advanced
sorry I missed this the first time!
There was a problem hiding this comment.
My bad, so few words and so many mistakes
|
Thanks for the doc update! |
|
I hope you squashed that :D |
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.
Description
Add an easy way to find yard plugins.
See issue #1139
Completed Tasks
bundle exec rakelocally (if code is attached to PR).