Skip to content

Commit

Permalink
Add link to documentation in error message; improve documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
joliss committed Oct 19, 2015
1 parent 36aa569 commit ec51d89
Show file tree
Hide file tree
Showing 2 changed files with 7 additions and 6 deletions.
10 changes: 5 additions & 5 deletions docs/broccoli-1-0-plugin-api.md
Expand Up @@ -92,7 +92,7 @@ If your plugin subclasses
[broccoli-filter](https://github.com/broccolijs/broccoli-filter), upgrade to
broccoli-filter 1.0.0 or newer. Be sure to call the base class constructor as
detailed [in the README](https://github.com/broccolijs/broccoli-filter/blob/master/README.md#upgrading-from-01x-to-1x);
other than that, no changes should be necessary.
other than that, no changes are needed.

### broccoli-caching-writer

Expand All @@ -103,10 +103,10 @@ upgrade to broccoli-caching-writer 2.0.0.
With version 2.0.0, broccoli-caching-writer's API is a drop-in replacement for
broccoli-plugin. As a result, its API is completely different from
broccoli-caching-writer 0.x/1.x, and your plugin's code will need to be
updated. To do so, it's best to consult read the README for
[broccoli-plugin](https://github.com/broccolijs/broccoli-plugin) to
familiarize yourself with the new API, and replace all instances of `Plugin`
with `CachingWriter`.
updated. To do so, it's best to read the
[broccoli-plugin README](https://github.com/broccolijs/broccoli-plugin) to
familiarize yourself with the new API, while replacing all instances of
`Plugin` with `CachingWriter` in your plugin code.

As a guide, where you previously implemented

Expand Down
3 changes: 2 additions & 1 deletion lib/builder.js
Expand Up @@ -130,7 +130,8 @@ Builder.prototype.makeNodeWrapper = function(node, _stack) {
node.constructor && node.constructor.name ||
('' + node)
message = legacyNodeDescription + ': The .read/.rebuild API is no longer supported as of Broccoli 1.0. ' +
'Plugins must now derive from broccoli-plugin.'
'Plugins must now derive from broccoli-plugin. ' +
'https://github.com/broccolijs/broccoli/blob/master/docs/broccoli-1-0-plugin-api.md'
} else {
message = node + ' is not a Broccoli node'
}
Expand Down

0 comments on commit ec51d89

Please sign in to comment.