Skip to content

Improve Behavior documentation #2365

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

Merged
merged 1 commit into from
Feb 24, 2015
Merged

Conversation

benmccormick
Copy link
Contributor

Two main goals

  1. Make it clear that View life cycle functions are available on
    Behaviors
  2. Improve grammar/consistency of docs when referencing Views and
    Behaviors

Specifically the docs had alternated between behavior, view, Behavior, View, and behavior, view
to refer to Behaviors and Views.

In addition to some spelling/grammar stuff, I attempted to fix this by following the convention that:

  • View and Behavior refer to the Marionette.View and Marionette.Behavior classes
  • View and Behavior refer to a View or Behavior class (possibly a subclass of View or Behavior)
  • view and behavior refer to instances of a View or Behavior class.

@samccone samccone added the docs label Feb 24, 2015
Two main goals
1. Make it clear that View life cycle functions are available on
Behaviors
2. Improve grammar/consistency of docs when referencing Views and
Behaviors

Specifically the docs had alternated between `behavior`, `view`, Behavior, View, and behavior, view
to refer to Behaviors and Views.

In addition to some spelling/grammar stuff, I attempted to fix this by following the convention that:

`View` and `Behavior` refer to the Marionette.View and Marionette.Behavior classes
View and Behavior refer to a View or Behavior class (possibly a subclass of `View` or `Behavior`)
view and behavior refer to instances of a View or Behavior class.
@coveralls
Copy link

Coverage Status

Coverage remained the same at 100.0% when pulling 4a38969 on benmccormick:master into 4a0ceb0 on marionettejs:master.

jasonLaster added a commit that referenced this pull request Feb 24, 2015
Improve Behavior documentation
@jasonLaster jasonLaster merged commit e2e14c7 into marionettejs:master Feb 24, 2015
@jasonLaster
Copy link
Member

Great! Great! Improvements

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants