Watch, Follow, &
Connect with Us
Public Report
Report From: 3rdRail/Docs    [ Add a report in this area ]  
Report #:  52461   Status: Closed
Help typos and stylistic issues
Project:  3rdRail Build #:  v20070909_1913
Version:    unspecifie Submitted By:   Clay Shannon
Report Type:  Minor failure / Design problem Date Reported:  9/24/2007 9:22:36 AM
Severity:    Infrequently encountered problem Last Updated: 12/17/2007 3:30:59 PM
Platform:    All versions Internal Tracking #:  
Resolution: Fixed (Resolution Comments) Resolved in Build: : V1 update 1
Duplicate of:  None
Voting and Rating
Overall Rating: No Ratings Yet
0.00 out of 5
Total Votes: None
Description
1) Topic: Create a New Rails Project

Bad verbiage: Freeze th Rails version

--should be "Freeze the Rails version"

2) Topic: The View

Bad verbiage: The Model View Controller Patter  

--should be "The Model View Controller Pattern"

3) Topic: Ruby on Rails

Bad verbiage: separates the applications data model,

--should be "separates the application's data model,"

4) Topic: The Rails Framework

Bad verbiage: The Rails framework is designed to develop database driven

--should probably be "The Rails framework is designed to develop database-driven"

Actually, there are several places where database driven should be, IMO, replaced by "database-driven"

5) Topic: Dont Repeat Yourself (DRY)

Bad verbiage:
a) Dont Repeat Yourself (DRY)

--should be "Don't Repeat Yourself (DRY)"

b) The governing principle of Rails development is DRY Code. This means Don't Repeat Yourself. This

principle is applied throughout rails every piece of information should be expressed in one place

to avoid bugs and streamline design updates.

--should be "The governing principle of Rails development is DRY. This means Don't Repeat Yourself.

This principle is applied throughout rails. Every piece of information should be expressed in one

place to avoid bugs and streamline design updates."

(remove the word "Code" (and if it's retained, don't capitalize it); also, add a period after

"rails" and uppercase "Every")
Steps to Reproduce:
None
Workarounds
None
Attachment
None
Comments

Joe McGlynn at 9/25/2007 6:30:11 PM -
Thanks for the report, this is added to our internal system as 3271

Server Response from: ETNACODE01