Bump version and update docs for v0.3.2 gem release #16

Merged
merged 2 commits into from May 10, 2013

Conversation

Projects
None yet
3 participants
Contributor

christoomey commented Apr 28, 2013

No description provided.

@joshuaclayton joshuaclayton commented on an outdated diff May 3, 2013

@@ -2,15 +2,17 @@
[![Build Status](https://travis-ci.org/thoughtbot/backbone-support.png?branch=master)](https://travis-ci.org/thoughtbot/backbone-support)
-There's no built-in garbage collection for Backbone’s event bindings, and
-forgetting to unbind can cause bugs and memory leaks.
+Backbone Support provides a collection of utility classes for use with
+[Backbone.js][]. There's no built-in garbage collection for Backbone’s event
+bindings, and forgetting to unbind can cause bugs and memory leaks. Backbone
+Support has your covered.
@joshuaclayton

joshuaclayton May 3, 2013

Owner

[typo] your

@joshuaclayton joshuaclayton commented on an outdated diff May 3, 2013

-Backbone Support currently provides two utility classes, SwappingRouter and CompositeView,
-that introduce a `leave()` function, which unbinds and cleans up the view.
-They should be used where views are instantiated (in Router instances and in composite views).
+Backbone Support currently provides two utility classes, SwappingRouter and
+CompositeView, that introduce a `leave()` function, which unbinds and cleans up
@joshuaclayton

joshuaclayton May 3, 2013

Owner

This seems like two ideas - what about something like "...provides two utility classes, SwappingRouter and CompositeView, which should be used where views are instantiated (in Router instances and in composite views), and introduce the leave() function. leave() unbinds and cleans up the view."

@joshuaclayton joshuaclayton commented on an outdated diff May 3, 2013

-## Development
-
-First:
-
- bundle
-
-While TDD'ing:
-
- bundle exec rake jasmine
-
-To not open tests in a browser window:
-
- bundle exec rake jasmine:ci
+If you require a different version of Backbone or Underscore than those
+provided by this gem, simply put the script files in
+`vendor/assets/javascripts` and they will take higher precedence than the
@joshuaclayton

joshuaclayton May 3, 2013

Owner

"vendor/assets/javascripts, which has higher precedence than"

@joshuaclayton joshuaclayton commented on an outdated diff May 3, 2013

## Installation
-The recommended usage is with Rails 3.1.
+The recommended usage is with Rails 3.1 or higher to take advantage of the
@joshuaclayton

joshuaclayton May 3, 2013

Owner

What about "We recommend you use Backbone-Support with Rails 3.1 or higher in order to take advantage of the asset pipeline"?

@joshuaclayton joshuaclayton commented on an outdated diff May 3, 2013

@@ -127,8 +117,19 @@ Add the gem to your Gemfile
And then `bundle install`
-In your application.js, or in whatever file your backbone.js assets are
-required in, add the following:
+Before including any part of Backbone Support, you must include its
+dependencies. In your application.js or any other manifest file, add the
@joshuaclayton

joshuaclayton May 3, 2013

Owner

maybe wrap "or any other manifest file" in a parenthetical?

@gabebw gabebw commented on an outdated diff May 3, 2013

-Backbone Support currently provides two utility classes, SwappingRouter and CompositeView,
-that introduce a `leave()` function, which unbinds and cleans up the view.
-They should be used where views are instantiated (in Router instances and in composite views).
+Backbone Support currently provides two utility classes, SwappingRouter and
@gabebw

gabebw May 3, 2013

I'd remove "currently" - unless you are The Doctor, or have access to time crystals, everything is "currently".

@gabebw gabebw commented on an outdated diff May 3, 2013

@@ -81,7 +83,7 @@ maintain a back-reference at `this.parent`. This is used to reach up and call
## Dependencies
-Backbone Support requires the following dependencies:
+Backbone Support has the following dependencies:
@gabebw

gabebw May 3, 2013

What do you think of "Backbone Support requires the following libraries"?

@gabebw gabebw commented on an outdated diff May 3, 2013

-### With Rails 3.1
+### With Rails 3.1 or higher
Add the gem to your Gemfile
@gabebw

gabebw May 3, 2013

Can you add a colon at the end of this line?

@gabebw gabebw commented on an outdated diff May 3, 2013

@@ -127,8 +117,19 @@ Add the gem to your Gemfile
And then `bundle install`
@gabebw

gabebw May 3, 2013

I'd add a period to the end of this line.

christoomey merged commit 5426a1a into master May 10, 2013

1 check passed

default The Travis CI build passed
Details
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment