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

Ticket #8796 (closed defect: fixed)

Opened 1 year ago

Last modified 1 year ago

[PATCH] Docs - Fix typos, add examples, and clean up CaptureHelper docs

Reported by: kampers Assigned to: core
Priority: normal Milestone: 1.x
Component: ActionPack Version: edge
Severity: normal Keywords: docs
Cc:

Description

There's a typo in the CaptureHelper docs about the deprecation of the @content_for_variable syntax. It has the old syntax wrapped in a pair of at-signs. I guess this was some old rdoc syntax? It's kind of strange to be accidental...? Well, it doesn't look wrong without them. Also, there are a couple legitimate grammar errors.

Three more things:

  1. I switched the documentation to use symbols as arguments to content_for -- <% content_for :nav do %> instead of <% content_for('nav') do %>. I think this is more elegant, Ruby-like, and seems to be more popular these days. It's also more 'symmetrical' with its matching call, <% yield :nav %>.
  2. I added an example showing how you can use content_for multiple times with the same identifier to concatenate markup.
  3. I nitpicked a few things here and there for grammar and style, to make it read more smoothly.

Patched against [7146].

Attachments

better_capture_helper_docs.diff (5.9 kB) - added by kampers on 06/28/07 15:57:43.
Fix typos, add examples, use better syntax, and clean up CaptureHelper docs

Change History

06/28/07 15:57:43 changed by kampers

  • attachment better_capture_helper_docs.diff added.

Fix typos, add examples, use better syntax, and clean up CaptureHelper docs

06/28/07 18:32:38 changed by bitsweat

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

(In [7148]) Improve capture helper documentation. Closes #8796.