Permalink
Browse files

Add periods to the bullet points in guides.

Talked with @fxn about this. Bullet points should have periods at the ends.
  • Loading branch information...
1 parent 5cdb23c commit 6dcae8ae9c21abd95cc119dd5625b4fb44fd4350 @steveklabnik steveklabnik committed Nov 29, 2012
@@ -3,13 +3,13 @@ Action Controller Overview
In this guide you will learn how controllers work and how they fit into the request cycle in your application. After reading this guide, you will be able to:
-* 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
+* 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.
--------------------------------------------------------------------------------
@@ -3,11 +3,11 @@ Action View Overview
In this guide you will learn:
-* What Action View is and how to use it with Rails
-* How best to use templates, partials, and layouts
-* What helpers are provided by Action View and how to make your own
-* How to use localized views
-* How to use Action View outside of Rails
+* What Action View is and how to use it with Rails.
+* How best to use templates, partials, and layouts.
+* What helpers are provided by Action View and how to make your own.
+* How to use localized views.
+* How to use Action View outside of Rails.
--------------------------------------------------------------------------------
@@ -3,11 +3,11 @@ Active Record Basics
This guide is an introduction to Active Record. After reading this guide we hope that you'll learn:
-* What Object Relational Mapping and Active Record are and how they are used in Rails
-* How Active Record fits into the Model-View-Controller paradigm
-* How to use Active Record models to manipulate data stored in a relational database
-* Active Record schema naming conventions
-* The concepts of database migrations, validations and callbacks
+* What Object Relational Mapping and Active Record are and how they are used in Rails.
+* How Active Record fits into the Model-View-Controller paradigm.
+* How to use Active Record models to manipulate data stored in a relational database.
+* Active Record schema naming conventions.
+* The concepts of database migrations, validations and callbacks.
--------------------------------------------------------------------------------
@@ -3,13 +3,13 @@ Active Record Query Interface
This guide covers different ways to retrieve data from the database using Active Record. By referring to this guide, you will be able to:
-* 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
+* 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.
--------------------------------------------------------------------------------
@@ -5,13 +5,13 @@ This guide teaches you how to hook into the life cycle of your Active Record obj
After reading this guide and trying out the presented concepts, we hope that you'll be able to:
-* Understand the life cycle of Active Record objects
-* Use the built-in Active Record validation helpers
-* Create your own custom validation methods
-* Work with the error messages generated by the validation process
-* Create callback methods that respond to events in the object life cycle
-* Create special classes that encapsulate common behavior for your callbacks
-* Create Observers that respond to life cycle events outside of the original class
+* Understand the life cycle of Active Record objects.
+* Use the built-in Active Record validation helpers.
+* Create your own custom validation methods.
+* Work with the error messages generated by the validation process.
+* Create callback methods that respond to events in the object life cycle.
+* Create special classes that encapsulate common behavior for your callbacks.
+* Create Observers that respond to life cycle events outside of the original class.
--------------------------------------------------------------------------------
@@ -5,10 +5,10 @@ Active Support is a part of core Rails that provides Ruby language extensions, u
In this guide, you will learn how to use the instrumentation API inside of Active Support to measure events inside of Rails and other Ruby code. We cover:
-* What instrumentation can provide
-* The hooks inside the Rails framework for instrumentation
-* Adding a subscriber to a hook
-* Building a custom instrumentation implementation
+* What instrumentation can provide.
+* The hooks inside the Rails framework for instrumentation.
+* Adding a subscriber to a hook.
+* Building a custom instrumentation implementation.
--------------------------------------------------------------------------------
@@ -4,11 +4,11 @@ Asset Pipeline
This guide covers the asset pipeline introduced in Rails 3.1.
By referring to this guide you will be able to:
-* 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
+* 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.
--------------------------------------------------------------------------------
@@ -3,9 +3,9 @@ A Guide to Active Record Associations
This guide covers the association features of Active Record. By referring to this guide, you will be able to:
-* Declare associations between Active Record models
-* Understand the various types of Active Record associations
-* Use the methods added to your models by creating associations
+* Declare associations between Active Record models.
+* Understand the various types of Active Record associations.
+* Use the methods added to your models by creating associations.
--------------------------------------------------------------------------------
@@ -5,10 +5,10 @@ This guide will teach you what you need to know about avoiding that expensive ro
After reading this guide, you should be able to use and configure:
-* Page, action, and fragment caching
-* Sweepers
-* Alternative cache stores
-* Conditional GET support
+* Page, action, and fragment caching.
+* Sweepers.
+* Alternative cache stores.
+* Conditional GET support.
--------------------------------------------------------------------------------
@@ -3,11 +3,11 @@ A Guide to The Rails Command Line
Rails comes with every command line tool you'll need to
-* 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
+* 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.
--------------------------------------------------------------------------------
@@ -3,8 +3,8 @@ Configuring Rails Applications
This guide covers the configuration and initialization features available to Rails applications. By referring to this guide, you will be able to:
-* Adjust the behavior of your Rails applications
-* Add additional code to be run at application start time
+* Adjust the behavior of your Rails applications.
+* Add additional code to be run at application start time.
--------------------------------------------------------------------------------
@@ -3,11 +3,11 @@ Contributing to Ruby on Rails
This guide covers ways in which _you_ can become a part of the ongoing development of Ruby on Rails. After reading it, you should be familiar with:
-* 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
+* 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.
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.
@@ -3,10 +3,10 @@ Debugging Rails Applications
This guide introduces techniques for debugging Ruby on Rails applications. By referring to this guide, you will be able to:
-* 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
+* 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.
--------------------------------------------------------------------------------
View
@@ -3,11 +3,11 @@ Getting Started with Engines
In this guide you will learn about engines and how they can be used to provide additional functionality to their host applications through a clean and very easy-to-use interface. You will learn the following things in this guide:
-* What makes an engine
-* How to generate an engine
-* Building features for the engine
-* Hooking the engine into an application
-* Overriding engine functionality in the application
+* What makes an engine.
+* How to generate an engine.
+* Building features for the engine.
+* Hooking the engine into an application.
+* Overriding engine functionality in the application.
--------------------------------------------------------------------------------
@@ -5,13 +5,13 @@ Forms in web applications are an essential interface for user input. However, fo
In this guide you will:
-* 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
+* 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.
--------------------------------------------------------------------------------
@@ -5,13 +5,13 @@ Rails generators are an essential tool if you plan to improve your workflow. Wit
In this guide you will:
-* 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
+* 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.
--------------------------------------------------------------------------------
View
@@ -7,15 +7,15 @@ The process of "internationalization" usually means to abstract all strings and
So, in the process of _internationalizing_ your Rails application you have to:
-* Ensure you have support for i18n
-* Tell Rails where to find locale dictionaries
-* Tell Rails how to set, preserve and switch locales
+* Ensure you have support for i18n.
+* Tell Rails where to find locale dictionaries.
+* Tell Rails how to set, preserve and switch locales.
In the process of _localizing_ your application you'll probably want to do the following three things:
* Replace or supplement Rails' default locale — e.g. date and time formats, month names, Active Record model names, etc.
* Abstract strings in your application into keyed dictionaries — e.g. flash messages, static text in your views, etc.
-* Store the resulting dictionaries somewhere
+* Store the resulting dictionaries somewhere.
This guide will walk you through the I18n API and contains a tutorial on how to internationalize a Rails application from the start.
@@ -4,7 +4,7 @@ The Rails Initialization Process
This guide explains the internals of the initialization process in Rails
as of Rails 4. It is an extremely in-depth guide and recommended for advanced Rails developers.
-* Using `rails server`
+* Using `rails server`.
--------------------------------------------------------------------------------
@@ -3,10 +3,10 @@ Layouts and Rendering in Rails
This guide covers the basic layout features of Action Controller and Action View. By referring to this guide, you will be able to:
-* 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)
+* 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).
--------------------------------------------------------------------------------
@@ -8,10 +8,10 @@ tables.
In this guide, you'll learn all about migrations including:
-* The generators you can use to create them
-* The methods Active Record provides to manipulate your database
-* The Rake tasks that manipulate migrations and your schema
-* How migrations relate to `schema.rb`
+* The generators you can use to create them.
+* The methods Active Record provides to manipulate your database.
+* The Rake tasks that manipulate migrations and your schema.
+* How migrations relate to `schema.rb`.
--------------------------------------------------------------------------------
@@ -5,7 +5,7 @@ Creating a form for a model _and_ its associations can become quite tedious. The
In this guide you will:
-* do stuff
+* do stuff.
--------------------------------------------------------------------------------
View
@@ -9,13 +9,13 @@ A Rails plugin is either an extension or a modification of the core framework. P
After reading this guide you should be familiar with:
-* Creating a plugin from scratch
-* Writing and running tests for the plugin
+* Creating a plugin from scratch.
+* Writing and running tests for the plugin.
This guide describes how to build a test-driven plugin that will:
-* Extend core Ruby classes like Hash and String
-* Add methods to ActiveRecord::Base in the tradition of the 'acts_as' plugins
+* Extend core Ruby classes like Hash and String.
+* Add methods to ActiveRecord::Base in the tradition of the 'acts_as' plugins.
* Give you information about where to put generators in your plugin.
For the purpose of this guide pretend for a moment that you are an avid bird watcher.
@@ -5,8 +5,8 @@ Application templates are simple Ruby files containing DSL for adding gems/initi
By referring to this guide, you will be able to:
-* Use templates to generate/customize Rails applications
-* Write your own reusable application templates using the Rails template API
+* Use templates to generate/customize Rails applications.
+* Write your own reusable application templates using the Rails template API.
--------------------------------------------------------------------------------
@@ -3,10 +3,10 @@ Rails on Rack
This guide covers Rails integration with Rack and interfacing with other Rack components. By referring to this guide, you will be able to:
-* Create Rails Metal applications
-* Use Rack Middlewares in your Rails applications
-* Understand Action Pack's internal Middleware stack
-* Define a custom Middleware stack
+* Create Rails Metal applications.
+* Use Rack Middlewares in your Rails applications.
+* Understand Action Pack's internal Middleware stack.
+* Define a custom Middleware stack.
--------------------------------------------------------------------------------
Oops, something went wrong.

0 comments on commit 6dcae8a

Please sign in to comment.