aboutsummaryrefslogtreecommitdiffstats
path: root/guides/source
diff options
context:
space:
mode:
authorKatie Oldaker <k.oldaker@modcloth.com>2012-12-07 12:50:09 -0500
committerKatie Oldaker <k.oldaker@modcloth.com>2012-12-07 12:50:09 -0500
commit7c05ea23a0e6394c61f3d2c1d0ba345784329427 (patch)
tree8472c0ab09bbe95d48659681609cf466c10812d9 /guides/source
parent70b809436fdc4f4f95155b0e5968e6cd10b80cd0 (diff)
downloadrails-7c05ea23a0e6394c61f3d2c1d0ba345784329427.tar.gz
rails-7c05ea23a0e6394c61f3d2c1d0ba345784329427.tar.bz2
rails-7c05ea23a0e6394c61f3d2c1d0ba345784329427.zip
Fixed grammar in a lot of guide prologues.
Diffstat (limited to 'guides/source')
-rw-r--r--guides/source/action_controller_overview.md14
-rw-r--r--guides/source/active_record_callbacks.md8
-rw-r--r--guides/source/active_record_querying.md14
-rw-r--r--guides/source/active_record_validations.md6
-rw-r--r--guides/source/asset_pipeline.md10
-rw-r--r--guides/source/association_basics.md6
-rw-r--r--guides/source/command_line.md10
-rw-r--r--guides/source/configuring.md4
-rw-r--r--guides/source/contributing_to_ruby_on_rails.md10
-rw-r--r--guides/source/debugging_rails_applications.md8
-rw-r--r--guides/source/form_helpers.md14
-rw-r--r--guides/source/generators.md14
-rw-r--r--guides/source/getting_started.md2
-rw-r--r--guides/source/initialization.md2
-rw-r--r--guides/source/layouts_and_rendering.md8
-rw-r--r--guides/source/performance_testing.md10
-rw-r--r--guides/source/plugins.md4
-rw-r--r--guides/source/rails_application_templates.md4
-rw-r--r--guides/source/rails_on_rack.md8
-rw-r--r--guides/source/routing.md10
-rw-r--r--guides/source/testing.md6
-rw-r--r--guides/source/working_with_javascript_in_rails.md4
22 files changed, 88 insertions, 88 deletions
diff --git a/guides/source/action_controller_overview.md b/guides/source/action_controller_overview.md
index 69d99becb9..dc672647cc 100644
--- a/guides/source/action_controller_overview.md
+++ b/guides/source/action_controller_overview.md
@@ -5,13 +5,13 @@ In this guide you will learn how controllers work and how they fit into the requ
After reading this guide, you will know:
-* Follow the flow of a request through a controller.
-* Understand why and how to store data in the session or cookies.
-* Work with filters to execute code during request processing.
-* Use Action Controller's built-in HTTP authentication.
-* Stream data directly to the user's browser.
-* Filter sensitive parameters so they do not appear in the application's log.
-* Deal with exceptions that may be raised during request processing.
+* How to follow the flow of a request through a controller.
+* Why and how to store data in the session or cookies.
+* How to work with filters to execute code during request processing.
+* How to use Action Controller's built-in HTTP authentication.
+* How to stream data directly to the user's browser.
+* How to filter sensitive parameters so they do not appear in the application's log.
+* How to deal with exceptions that may be raised during request processing.
--------------------------------------------------------------------------------
diff --git a/guides/source/active_record_callbacks.md b/guides/source/active_record_callbacks.md
index c45f3f2e6a..550800861d 100644
--- a/guides/source/active_record_callbacks.md
+++ b/guides/source/active_record_callbacks.md
@@ -4,11 +4,11 @@ Active Record Callbacks
This guide teaches you how to hook into the life cycle of your Active Record
objects.
-After reading this guide and trying out the presented concepts, we hope that you'll be able to:
+After reading this guide, you will know:
-* Understand the life cycle of Active Record objects
-* Create callback methods that respond to events in the object life cycle
-* Create special classes that encapsulate common behavior for your callbacks
+* The life cycle of Active Record objects.
+* How to create callback methods that respond to events in the object life cycle.
+* How to create special classes that encapsulate common behavior for your callbacks.
--------------------------------------------------------------------------------
diff --git a/guides/source/active_record_querying.md b/guides/source/active_record_querying.md
index b22cc09951..4ee6374175 100644
--- a/guides/source/active_record_querying.md
+++ b/guides/source/active_record_querying.md
@@ -5,13 +5,13 @@ This guide covers different ways to retrieve data from the database using Active
After reading this guide, you will know:
-* Find records using a variety of methods and conditions.
-* Specify the order, retrieved attributes, grouping, and other properties of the found records.
-* Use eager loading to reduce the number of database queries needed for data retrieval.
-* Use dynamic finders methods.
-* Check for the existence of particular records.
-* Perform various calculations on Active Record models.
-* Run EXPLAIN on relations.
+* How to find records using a variety of methods and conditions.
+* How to specify the order, retrieved attributes, grouping, and other properties of the found records.
+* How to use eager loading to reduce the number of database queries needed for data retrieval.
+* How to use dynamic finders methods.
+* How to check for the existence of particular records.
+* How to perform various calculations on Active Record models.
+* How to run EXPLAIN on relations.
--------------------------------------------------------------------------------
diff --git a/guides/source/active_record_validations.md b/guides/source/active_record_validations.md
index e752c6f3f9..f8cc759d9c 100644
--- a/guides/source/active_record_validations.md
+++ b/guides/source/active_record_validations.md
@@ -6,9 +6,9 @@ the database using Active Record's validations feature.
After reading this guide, you will know:
-* Use the built-in Active Record validation helpers
-* Create your own custom validation methods
-* Work with the error messages generated by the validation process
+* How to use the built-in Active Record validation helpers.
+* How to create your own custom validation methods.
+* How to work with the error messages generated by the validation process.
--------------------------------------------------------------------------------
diff --git a/guides/source/asset_pipeline.md b/guides/source/asset_pipeline.md
index a4d6463035..a00d019cc1 100644
--- a/guides/source/asset_pipeline.md
+++ b/guides/source/asset_pipeline.md
@@ -5,11 +5,11 @@ This guide covers the asset pipeline introduced in Rails 3.1.
After reading this guide, you will know:
-* Understand what the asset pipeline is and what it does.
-* Properly organize your application assets.
-* Understand the benefits of the asset pipeline.
-* Add a pre-processor to the pipeline.
-* Package assets with a gem.
+* How to understand what the asset pipeline is and what it does.
+* How to properly organize your application assets.
+* How to understand the benefits of the asset pipeline.
+* How to add a pre-processor to the pipeline.
+* How to package assets with a gem.
--------------------------------------------------------------------------------
diff --git a/guides/source/association_basics.md b/guides/source/association_basics.md
index 43d3b20165..2f407c603d 100644
--- a/guides/source/association_basics.md
+++ b/guides/source/association_basics.md
@@ -5,9 +5,9 @@ This guide covers the association features of Active Record.
After reading this guide, you will know:
-* Declare associations between Active Record models.
-* Understand the various types of Active Record associations.
-* Use the methods added to your models by creating associations.
+* How to declare associations between Active Record models.
+* How to understand the various types of Active Record associations.
+* How to use the methods added to your models by creating associations.
--------------------------------------------------------------------------------
diff --git a/guides/source/command_line.md b/guides/source/command_line.md
index 0a4a704cd9..746226fa96 100644
--- a/guides/source/command_line.md
+++ b/guides/source/command_line.md
@@ -5,11 +5,11 @@ Rails comes with every command line tool you'll need to
After reading this guide, you will know:
-* Create a Rails application.
-* Generate models, controllers, database migrations, and unit tests.
-* Start a development server.
-* Experiment with objects through an interactive shell.
-* Profile and benchmark your new creation.
+* How to create a Rails application.
+* How to generate models, controllers, database migrations, and unit tests.
+* How to start a development server.
+* How to experiment with objects through an interactive shell.
+* How to profile and benchmark your new creation.
--------------------------------------------------------------------------------
diff --git a/guides/source/configuring.md b/guides/source/configuring.md
index dba2be3b71..eae0f5b641 100644
--- a/guides/source/configuring.md
+++ b/guides/source/configuring.md
@@ -5,8 +5,8 @@ This guide covers the configuration and initialization features available to Rai
After reading this guide, you will know:
-* Adjust the behavior of your Rails applications.
-* Add additional code to be run at application start time.
+* How to adjust the behavior of your Rails applications.
+* How to add additional code to be run at application start time.
--------------------------------------------------------------------------------
diff --git a/guides/source/contributing_to_ruby_on_rails.md b/guides/source/contributing_to_ruby_on_rails.md
index fa6c335088..1e0cb6ee4a 100644
--- a/guides/source/contributing_to_ruby_on_rails.md
+++ b/guides/source/contributing_to_ruby_on_rails.md
@@ -5,11 +5,11 @@ This guide covers ways in which _you_ can become a part of the ongoing developme
After reading this guide, you will know:
-* Using GitHub to report issues.
-* Cloning master and running the test suite.
-* Helping to resolve existing issues.
-* Contributing to the Ruby on Rails documentation.
-* Contributing to the Ruby on Rails code.
+* How to use GitHub to report issues.
+* How to clone master and run the test suite.
+* How to help resolve existing issues.
+* How to contribute to the Ruby on Rails documentation.
+* How to contribute to the Ruby on Rails code.
Ruby on Rails is not "someone else's framework." Over the years, hundreds of people have contributed to Ruby on Rails ranging from a single character to massive architectural changes or significant documentation — all with the goal of making Ruby on Rails better for everyone. Even if you don't feel up to writing code or documentation yet, there are a variety of other ways that you can contribute, from reporting issues to testing patches.
diff --git a/guides/source/debugging_rails_applications.md b/guides/source/debugging_rails_applications.md
index 96112da50f..addc3a63a8 100644
--- a/guides/source/debugging_rails_applications.md
+++ b/guides/source/debugging_rails_applications.md
@@ -5,10 +5,10 @@ This guide introduces techniques for debugging Ruby on Rails applications.
After reading this guide, you will know:
-* Understand the purpose of debugging.
-* Track down problems and issues in your application that your tests aren't identifying.
-* Learn the different ways of debugging.
-* Analyze the stack trace.
+* The purpose of debugging.
+* How to track down problems and issues in your application that your tests aren't identifying.
+* The different ways of debugging.
+* How to analyze the stack trace.
--------------------------------------------------------------------------------
diff --git a/guides/source/form_helpers.md b/guides/source/form_helpers.md
index b89d776d87..d22b2f8ef6 100644
--- a/guides/source/form_helpers.md
+++ b/guides/source/form_helpers.md
@@ -5,13 +5,13 @@ Forms in web applications are an essential interface for user input. However, fo
After reading this guide, you will know:
-* Create search forms and similar kind of generic forms not representing any specific model in your application.
-* Make model-centric forms for creation and editing of specific database records.
-* Generate select boxes from multiple types of data.
-* Understand the date and time helpers Rails provides.
-* Learn what makes a file upload form different.
-* Learn some cases of building forms to external resources.
-* Find out how to build complex forms.
+* How to create search forms and similar kind of generic forms not representing any specific model in your application.
+* How to make model-centric forms for creation and editing of specific database records.
+* How to generate select boxes from multiple types of data.
+* The date and time helpers Rails provides.
+* What makes a file upload form different.
+* Some cases of building forms to external resources.
+* How to build complex forms.
--------------------------------------------------------------------------------
diff --git a/guides/source/generators.md b/guides/source/generators.md
index f83f5c6691..d23110edd6 100644
--- a/guides/source/generators.md
+++ b/guides/source/generators.md
@@ -5,13 +5,13 @@ Rails generators are an essential tool if you plan to improve your workflow. Wit
After reading this guide, you will know:
-* Learn how to see which generators are available in your application.
-* Create a generator using templates.
-* Learn how Rails searches for generators before invoking them.
-* Customize your scaffold by creating new generators.
-* Customize your scaffold by changing generator templates.
-* Learn how to use fallbacks to avoid overwriting a huge set of generators.
-* Learn how to create an application template.
+* How to see which generators are available in your application.
+* How to create a generator using templates.
+* How Rails searches for generators before invoking them.
+* How to customize your scaffold by creating new generators.
+* How to customize your scaffold by changing generator templates.
+* How to use fallbacks to avoid overwriting a huge set of generators.
+* How to create an application template.
--------------------------------------------------------------------------------
diff --git a/guides/source/getting_started.md b/guides/source/getting_started.md
index db067ce62e..37760e4393 100644
--- a/guides/source/getting_started.md
+++ b/guides/source/getting_started.md
@@ -5,7 +5,7 @@ This guide covers getting up and running with Ruby on Rails.
After reading this guide, you will know:
-* Installing Rails, creating a new Rails application, and connecting your
+* How to install Rails, create a new Rails application, and connect your
application to a database.
* The general layout of a Rails application.
* The basic principles of MVC (Model, View, Controller) and RESTful design.
diff --git a/guides/source/initialization.md b/guides/source/initialization.md
index 6a34125654..32df508f9c 100644
--- a/guides/source/initialization.md
+++ b/guides/source/initialization.md
@@ -6,7 +6,7 @@ as of Rails 4. It is an extremely in-depth guide and recommended for advanced Ra
After reading this guide, you will know:
-* Using `rails server`.
+* How to use `rails server`.
--------------------------------------------------------------------------------
diff --git a/guides/source/layouts_and_rendering.md b/guides/source/layouts_and_rendering.md
index 394ef794d3..b23ae04380 100644
--- a/guides/source/layouts_and_rendering.md
+++ b/guides/source/layouts_and_rendering.md
@@ -5,10 +5,10 @@ This guide covers the basic layout features of Action Controller and Action View
After reading this guide, you will know:
-* Use the various rendering methods built into Rails.
-* Create layouts with multiple content sections.
-* Use partials to DRY up your views.
-* Use nested layouts (sub-templates).
+* How to use the various rendering methods built into Rails.
+* How to create layouts with multiple content sections.
+* How to use partials to DRY up your views.
+* How to use nested layouts (sub-templates).
--------------------------------------------------------------------------------
diff --git a/guides/source/performance_testing.md b/guides/source/performance_testing.md
index a07f64ec29..182f7eb0fd 100644
--- a/guides/source/performance_testing.md
+++ b/guides/source/performance_testing.md
@@ -6,12 +6,12 @@ application.
After reading this guide, you will know:
-* Understand the various types of benchmarking and profiling metrics.
-* Generate performance and benchmarking tests.
-* Install and use a GC-patched Ruby binary to measure memory usage and object
+* The various types of benchmarking and profiling metrics.
+* How to generate performance and benchmarking tests.
+* How to install and use a GC-patched Ruby binary to measure memory usage and object
allocation.
-* Understand the benchmarking information provided by Rails inside the log files.
-* Learn about various tools facilitating benchmarking and profiling.
+* The benchmarking information provided by Rails inside the log files.
+* Various tools facilitating benchmarking and profiling.
Performance testing is an integral part of the development cycle. It is very
important that you don't make your end users wait for too long before the page
diff --git a/guides/source/plugins.md b/guides/source/plugins.md
index c7c843ec3a..42746e34d7 100644
--- a/guides/source/plugins.md
+++ b/guides/source/plugins.md
@@ -9,8 +9,8 @@ A Rails plugin is either an extension or a modification of the core framework. P
After reading this guide, you will know:
-* Creating a plugin from scratch.
-* Writing and running tests for the plugin.
+* How to create a plugin from scratch.
+* How to write and run tests for the plugin.
This guide describes how to build a test-driven plugin that will:
diff --git a/guides/source/rails_application_templates.md b/guides/source/rails_application_templates.md
index 83c563ac78..9e694acb98 100644
--- a/guides/source/rails_application_templates.md
+++ b/guides/source/rails_application_templates.md
@@ -5,8 +5,8 @@ Application templates are simple Ruby files containing DSL for adding gems/initi
After reading this guide, you will know:
-* Use templates to generate/customize Rails applications.
-* Write your own reusable application templates using the Rails template API.
+* How to use templates to generate/customize Rails applications.
+* How to write your own reusable application templates using the Rails template API.
--------------------------------------------------------------------------------
diff --git a/guides/source/rails_on_rack.md b/guides/source/rails_on_rack.md
index 531b35a973..1fac6d9883 100644
--- a/guides/source/rails_on_rack.md
+++ b/guides/source/rails_on_rack.md
@@ -5,10 +5,10 @@ This guide covers Rails integration with Rack and interfacing with other Rack co
After reading this guide, you will know:
-* Create Rails Metal applications.
-* Use Rack Middlewares in your Rails applications.
-* Understand Action Pack's internal Middleware stack.
-* Define a custom Middleware stack.
+* How to create Rails Metal applications.
+* How to use Rack Middlewares in your Rails applications.
+* Action Pack's internal Middleware stack.
+* How to define a custom Middleware stack.
--------------------------------------------------------------------------------
diff --git a/guides/source/routing.md b/guides/source/routing.md
index 714c0b609e..0e78e7d4cd 100644
--- a/guides/source/routing.md
+++ b/guides/source/routing.md
@@ -5,11 +5,11 @@ This guide covers the user-facing features of Rails routing.
After reading this guide, you will know:
-* Understand the code in `routes.rb`.
-* Construct your own routes, using either the preferred resourceful style or the `match` method.
-* Identify what parameters to expect an action to receive.
-* Automatically create paths and URLs using route helpers.
-* Use advanced techniques such as constraints and Rack endpoints.
+* How to interpret the code in `routes.rb`.
+* How to construct your own routes, using either the preferred resourceful style or the `match` method.
+* What parameters to expect an action to receive.
+* How to automatically create paths and URLs using route helpers.
+* Advanced techniques such as constraints and Rack endpoints.
--------------------------------------------------------------------------------
diff --git a/guides/source/testing.md b/guides/source/testing.md
index 9ce94f4c53..a9bce04522 100644
--- a/guides/source/testing.md
+++ b/guides/source/testing.md
@@ -6,9 +6,9 @@ application.
After reading this guide, you will know:
-* Understand Rails testing terminology.
-* Write unit, functional, and integration tests for your application.
-* Identify other popular testing approaches and plugins.
+* Rails testing terminology.
+* How to write unit, functional, and integration tests for your application.
+* Other popular testing approaches and plugins.
--------------------------------------------------------------------------------
diff --git a/guides/source/working_with_javascript_in_rails.md b/guides/source/working_with_javascript_in_rails.md
index 26e3403ff9..0f5acfba3c 100644
--- a/guides/source/working_with_javascript_in_rails.md
+++ b/guides/source/working_with_javascript_in_rails.md
@@ -7,10 +7,10 @@ ease!
After reading this guide, you will know:
-* Quick introduction to Ajax.
+* The basics of Ajax.
* Unobtrusive JavaScript.
* How Rails' built-in helpers assist you.
-* Handling Ajax on the server side.
+* How to handle Ajax on the server side.
* The Turbolinks gem.
-------------------------------------------------------------------------------