Ruby on Rails | Screencasts | Download | Documentation | Weblog | Community | Source

Ticket #8732 (closed defect: fixed)

Opened 1 year ago

Last modified 1 year ago

[PATCH] Improve documentation option list consistency

Reported by: ryanb Assigned to: core
Priority: normal Milestone: 2.x
Component: ActiveRecord Version: edge
Severity: normal Keywords: docs
Cc:

Description

The option lists in the documentation are rather inconsistant in their use of the separator character. Some use a colon while others use a dash. This patch changes them all to a dash. I chose this because it is less confusing when used next to a symbol.

I also fixed some broken markup such as +:foo+, changing it to <tt>:foo</tt> so it appears correct.

Attachments

doc_options_consistancy.diff (37.8 kB) - added by ryanb on 06/23/07 19:10:19.

Change History

06/23/07 19:10:19 changed by ryanb

  • attachment doc_options_consistancy.diff added.

11/06/07 23:32:02 changed by marcel

This is a great effort toward normalizing how options are specified. I'm sorry to report that since it was left to languish so long before being applied that it only applies half way cleanly. About half of the changes fail to apply. I can imagine how tedious it would be to go through and redo all of this. I'll apply the bits that did apply cleanly and close this ticket. If you are up to fixing up the ones that remain that would be cool. Thanks regardless.

11/06/07 23:33:47 changed by marcel

  • status changed from new to closed.
  • resolution set to fixed.

(In [8106]) Standardize on using hyphens rather than colons to separate option names from their explanation in documentation. Replace + with tt tags. Closes #8732. [ryanb]