Skip to content

Commit

Permalink
Update API docs
Browse files Browse the repository at this point in the history
  • Loading branch information
ianwhite committed Oct 8, 2009
1 parent 9b935ef commit 35777a7
Show file tree
Hide file tree
Showing 33 changed files with 61 additions and 47 deletions.
2 changes: 1 addition & 1 deletion doc/classes/Ardes/ActiveRecord.html
@@ -1,7 +1,7 @@
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/strict.dtd">
<html lang='en'>
<head>
<title>: Ardes::ActiveRecord [Resources Controller API Documentation (2c87336)]</title>
<title>: Ardes::ActiveRecord [Resources Controller API Documentation (14a40aa)]</title>
<meta content='text/html; charset=utf-8' http-equiv='Content-Type'>
<link href='../../rdoc-style.css' media='screen' rel='stylesheet' type='text/css'>
<script type='text/javascript'>
Expand Down
2 changes: 1 addition & 1 deletion doc/classes/Ardes/ActiveRecord/Saved.html
@@ -1,7 +1,7 @@
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/strict.dtd">
<html lang='en'>
<head>
<title>: Ardes::ActiveRecord::Saved [Resources Controller API Documentation (2c87336)]</title>
<title>: Ardes::ActiveRecord::Saved [Resources Controller API Documentation (14a40aa)]</title>
<meta content='text/html; charset=utf-8' http-equiv='Content-Type'>
<link href='../../../rdoc-style.css' media='screen' rel='stylesheet' type='text/css'>
<script type='text/javascript'>
Expand Down
2 changes: 1 addition & 1 deletion doc/classes/Ardes/ResourcesController.html
@@ -1,7 +1,7 @@
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/strict.dtd">
<html lang='en'>
<head>
<title>: Ardes::ResourcesController [Resources Controller API Documentation (2c87336)]</title>
<title>: Ardes::ResourcesController [Resources Controller API Documentation (14a40aa)]</title>
<meta content='text/html; charset=utf-8' http-equiv='Content-Type'>
<link href='../../rdoc-style.css' media='screen' rel='stylesheet' type='text/css'>
<script type='text/javascript'>
Expand Down
2 changes: 1 addition & 1 deletion doc/classes/Ardes/ResourcesController/Actions.html
@@ -1,7 +1,7 @@
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/strict.dtd">
<html lang='en'>
<head>
<title>: Ardes::ResourcesController::Actions [Resources Controller API Documentation (2c87336)]</title>
<title>: Ardes::ResourcesController::Actions [Resources Controller API Documentation (14a40aa)]</title>
<meta content='text/html; charset=utf-8' http-equiv='Content-Type'>
<link href='../../../rdoc-style.css' media='screen' rel='stylesheet' type='text/css'>
<script type='text/javascript'>
Expand Down
2 changes: 1 addition & 1 deletion doc/classes/Ardes/ResourcesController/ClassMethods.html
@@ -1,7 +1,7 @@
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/strict.dtd">
<html lang='en'>
<head>
<title>: Ardes::ResourcesController::ClassMethods [Resources Controller API Documentation (2c87336)]</title>
<title>: Ardes::ResourcesController::ClassMethods [Resources Controller API Documentation (14a40aa)]</title>
<meta content='text/html; charset=utf-8' http-equiv='Content-Type'>
<link href='../../../rdoc-style.css' media='screen' rel='stylesheet' type='text/css'>
<script type='text/javascript'>
Expand Down
2 changes: 1 addition & 1 deletion doc/classes/Ardes/ResourcesController/Helper.html
@@ -1,7 +1,7 @@
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/strict.dtd">
<html lang='en'>
<head>
<title>: Ardes::ResourcesController::Helper [Resources Controller API Documentation (2c87336)]</title>
<title>: Ardes::ResourcesController::Helper [Resources Controller API Documentation (14a40aa)]</title>
<meta content='text/html; charset=utf-8' http-equiv='Content-Type'>
<link href='../../../rdoc-style.css' media='screen' rel='stylesheet' type='text/css'>
<script type='text/javascript'>
Expand Down
2 changes: 1 addition & 1 deletion doc/classes/Ardes/ResourcesController/IncludeActions.html
@@ -1,7 +1,7 @@
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/strict.dtd">
<html lang='en'>
<head>
<title>: Ardes::ResourcesController::IncludeActions [Resources Controller API Documentation (2c87336)]</title>
<title>: Ardes::ResourcesController::IncludeActions [Resources Controller API Documentation (14a40aa)]</title>
<meta content='text/html; charset=utf-8' http-equiv='Content-Type'>
<link href='../../../rdoc-style.css' media='screen' rel='stylesheet' type='text/css'>
<script type='text/javascript'>
Expand Down
2 changes: 1 addition & 1 deletion doc/classes/Ardes/ResourcesController/InstanceMethods.html
@@ -1,7 +1,7 @@
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/strict.dtd">
<html lang='en'>
<head>
<title>: Ardes::ResourcesController::InstanceMethods [Resources Controller API Documentation (2c87336)]</title>
<title>: Ardes::ResourcesController::InstanceMethods [Resources Controller API Documentation (14a40aa)]</title>
<meta content='text/html; charset=utf-8' http-equiv='Content-Type'>
<link href='../../../rdoc-style.css' media='screen' rel='stylesheet' type='text/css'>
<script type='text/javascript'>
Expand Down
@@ -1,7 +1,7 @@
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/strict.dtd">
<html lang='en'>
<head>
<title>: Ardes::ResourcesController::NamedRouteHelper [Resources Controller API Documentation (2c87336)]</title>
<title>: Ardes::ResourcesController::NamedRouteHelper [Resources Controller API Documentation (14a40aa)]</title>
<meta content='text/html; charset=utf-8' http-equiv='Content-Type'>
<link href='../../../rdoc-style.css' media='screen' rel='stylesheet' type='text/css'>
<script type='text/javascript'>
Expand Down
@@ -1,7 +1,7 @@
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/strict.dtd">
<html lang='en'>
<head>
<title>: Ardes::ResourcesController::RequestPathIntrospection [Resources Controller API Documentation (2c87336)]</title>
<title>: Ardes::ResourcesController::RequestPathIntrospection [Resources Controller API Documentation (14a40aa)]</title>
<meta content='text/html; charset=utf-8' http-equiv='Content-Type'>
<link href='../../../rdoc-style.css' media='screen' rel='stylesheet' type='text/css'>
<script type='text/javascript'>
Expand Down Expand Up @@ -84,7 +84,7 @@ <h2>Protected instance methods</h2>
<a class='source-toggle' href='#' onclick="toggleCode('M000009-source'); return false">
[show source]
</a>
<pre id='M000009-source'> <span class="ruby-comment cmt"># File lib/ardes/resources_controller/request_path_introspection.rb, line 13</span>&#x000A;13: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">nesting_request_path</span>&#x000A;14: <span class="ruby-ivar">@nesting_request_path</span> <span class="ruby-operator">||=</span> <span class="ruby-identifier">remove_namespace</span>(<span class="ruby-identifier">request_path</span>.<span class="ruby-identifier">sub</span>(<span class="ruby-node">%r(/#{current_segment}(?!.*/#{current_segment}).*$)</span>, <span class="ruby-value str">''</span>))&#x000A;15: <span class="ruby-keyword kw">end</span></pre>
<pre id='M000009-source'> <span class="ruby-comment cmt"># File lib/ardes/resources_controller/request_path_introspection.rb, line 13</span>&#x000A;13: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">nesting_request_path</span>&#x000A;14: <span class="ruby-ivar">@nesting_request_path</span> <span class="ruby-operator">||=</span> <span class="ruby-identifier">remove_namespace</span>(<span class="ruby-identifier">remove_current_segment</span>(<span class="ruby-identifier">request_path</span>))&#x000A;15: <span class="ruby-keyword kw">end</span></pre>
</div>
</div>
<div class='protected-instance method' id='method-M000010'>
Expand Down
2 changes: 1 addition & 1 deletion doc/classes/Ardes/ResourcesController/ResourceService.html
@@ -1,7 +1,7 @@
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/strict.dtd">
<html lang='en'>
<head>
<title>: Ardes::ResourcesController::ResourceService [Resources Controller API Documentation (2c87336)]</title>
<title>: Ardes::ResourcesController::ResourceService [Resources Controller API Documentation (14a40aa)]</title>
<meta content='text/html; charset=utf-8' http-equiv='Content-Type'>
<link href='../../../rdoc-style.css' media='screen' rel='stylesheet' type='text/css'>
<script type='text/javascript'>
Expand Down
@@ -1,7 +1,7 @@
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/strict.dtd">
<html lang='en'>
<head>
<title>: Ardes::ResourcesController::SingletonActions [Resources Controller API Documentation (2c87336)]</title>
<title>: Ardes::ResourcesController::SingletonActions [Resources Controller API Documentation (14a40aa)]</title>
<meta content='text/html; charset=utf-8' http-equiv='Content-Type'>
<link href='../../../rdoc-style.css' media='screen' rel='stylesheet' type='text/css'>
<script type='text/javascript'>
Expand Down
@@ -1,7 +1,7 @@
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/strict.dtd">
<html lang='en'>
<head>
<title>: Ardes::ResourcesController::SingletonResourceService [Resources Controller API Documentation (2c87336)]</title>
<title>: Ardes::ResourcesController::SingletonResourceService [Resources Controller API Documentation (14a40aa)]</title>
<meta content='text/html; charset=utf-8' http-equiv='Content-Type'>
<link href='../../../rdoc-style.css' media='screen' rel='stylesheet' type='text/css'>
<script type='text/javascript'>
Expand Down
@@ -1,7 +1,7 @@
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/strict.dtd">
<html lang='en'>
<head>
<title>: Ardes::ResourcesController::SingletonSpecification [Resources Controller API Documentation (2c87336)]</title>
<title>: Ardes::ResourcesController::SingletonSpecification [Resources Controller API Documentation (14a40aa)]</title>
<meta content='text/html; charset=utf-8' http-equiv='Content-Type'>
<link href='../../../rdoc-style.css' media='screen' rel='stylesheet' type='text/css'>
<script type='text/javascript'>
Expand Down
2 changes: 1 addition & 1 deletion doc/classes/Ardes/ResourcesController/Specification.html
@@ -1,7 +1,7 @@
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/strict.dtd">
<html lang='en'>
<head>
<title>: Ardes::ResourcesController::Specification [Resources Controller API Documentation (2c87336)]</title>
<title>: Ardes::ResourcesController::Specification [Resources Controller API Documentation (14a40aa)]</title>
<meta content='text/html; charset=utf-8' http-equiv='Content-Type'>
<link href='../../../rdoc-style.css' media='screen' rel='stylesheet' type='text/css'>
<script type='text/javascript'>
Expand Down
2 changes: 1 addition & 1 deletion doc/created.rid
@@ -1 +1 @@
Tue, 29 Sep 2009 17:10:45 +0100
Thu, 08 Oct 2009 09:31:28 -0400
7 changes: 5 additions & 2 deletions doc/files/History_txt.html
@@ -1,7 +1,7 @@
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/strict.dtd">
<html lang='en'>
<head>
<title>File: History.txt [Resources Controller API Documentation (2c87336)]</title>
<title>File: History.txt [Resources Controller API Documentation (14a40aa)]</title>
<meta content='text/html; charset=utf-8' http-equiv='Content-Type'>
<link href='../rdoc-style.css' media='screen' rel='stylesheet' type='text/css'>
<script type='text/javascript'>
Expand Down Expand Up @@ -31,13 +31,16 @@ <h1 class='name'>History.txt</h1>
</div>
<div class='last-update'>
Last Update:
<span class='datetime'>Tue Sep 29 09:38:02 +0100 2009</span>
<span class='datetime'>Thu Oct 08 09:13:29 -0400 2009</span>
</div>
</div>
<div id='content'>
<div id='text'>
<div id='description'>
<ul>
<li>Fix bug where id is the same name as the resource name [mocoso]

</li>
<li>Bugs introduced with RequestPathIntrospection (5 and 6 on lighthouse)
solved thanks to Sergei Serdyuk

Expand Down
4 changes: 2 additions & 2 deletions doc/files/License_txt.html
@@ -1,7 +1,7 @@
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/strict.dtd">
<html lang='en'>
<head>
<title>File: License.txt [Resources Controller API Documentation (2c87336)]</title>
<title>File: License.txt [Resources Controller API Documentation (14a40aa)]</title>
<meta content='text/html; charset=utf-8' http-equiv='Content-Type'>
<link href='../rdoc-style.css' media='screen' rel='stylesheet' type='text/css'>
<script type='text/javascript'>
Expand Down Expand Up @@ -31,7 +31,7 @@ <h1 class='name'>License.txt</h1>
</div>
<div class='last-update'>
Last Update:
<span class='datetime'>Tue Sep 29 09:38:02 +0100 2009</span>
<span class='datetime'>Tue Sep 29 12:15:31 -0400 2009</span>
</div>
</div>
<div id='content'>
Expand Down
15 changes: 13 additions & 2 deletions doc/files/README_rdoc.html
@@ -1,7 +1,7 @@
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/strict.dtd">
<html lang='en'>
<head>
<title>File: README.rdoc [Resources Controller API Documentation (2c87336)]</title>
<title>File: README.rdoc [Resources Controller API Documentation (14a40aa)]</title>
<meta content='text/html; charset=utf-8' http-equiv='Content-Type'>
<link href='../rdoc-style.css' media='screen' rel='stylesheet' type='text/css'>
<script type='text/javascript'>
Expand Down Expand Up @@ -31,7 +31,7 @@
</div>
<div class='last-update'>
Last Update:
<span class='datetime'>Tue Sep 29 09:38:02 +0100 2009</span>
<span class='datetime'>Thu Oct 08 09:28:49 -0400 2009</span>
</div>
</div>
<div id='content'>
Expand Down Expand Up @@ -99,6 +99,17 @@ <h2>Continuous Integration</h2>
href="http://github.com/ianwhite/garlic">github.com/ianwhite/garlic</a>) is
used for CI. To run the CI suite have a look at garlic.rb
</p>
<h2>How to contribute</h2>
<p>
If you have found a bug, or have a new feature, then spec&#8217;d code is
great. To make sure you haven&#8217;t broken rc, you want to run the ci
suite. This is pretty easy, you just need to install garlic, and run it in
a fresh checkout of rc. The first time it runs it will be a little slow, as
it needs to check out various git repos, but subsequent runs will be fast.
The following is how I work - you may want to only do a subset of this
stuff
</p>
<pre>sudo gem install garlic&#x000A;&#x000A;# add the following line to your ~/.profile&#x000A; source `garlic --path`/sh/garlic.sh&#x000A;&#x000A;# reload your profile&#x000A;. ~/.profile&#x000A;&#x000A;# grab resources_controller and run the suite for the first time&#x000A;git clone git://github.com/ianwhite/resources_controller.git&#x000A;cd resources_controller&#x000A;garlic all&#x000A;&#x000A;# jump into 2-3 garlic work repo to make some changes&#x000A;gcdp 2-3&#x000A;&#x000A;# commit some stuff, run the specs with 'rake' etc&#x000A;&#x000A;# then push up to the local master repo&#x000A;gpush&#x000A;&#x000A;# go back to the local master, run garlic again, to see if the 2-3 changes affected anything else&#x000A;gup&#x000A;garlic</pre>
<h2>Contributors</h2>
<p>
The following people have made contributions to resources_controller.
Expand Down
4 changes: 2 additions & 2 deletions doc/files/Todo_txt.html
@@ -1,7 +1,7 @@
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/strict.dtd">
<html lang='en'>
<head>
<title>File: Todo.txt [Resources Controller API Documentation (2c87336)]</title>
<title>File: Todo.txt [Resources Controller API Documentation (14a40aa)]</title>
<meta content='text/html; charset=utf-8' http-equiv='Content-Type'>
<link href='../rdoc-style.css' media='screen' rel='stylesheet' type='text/css'>
<script type='text/javascript'>
Expand Down Expand Up @@ -31,7 +31,7 @@ <h1 class='name'>Todo.txt</h1>
</div>
<div class='last-update'>
Last Update:
<span class='datetime'>Tue Sep 29 09:38:02 +0100 2009</span>
<span class='datetime'>Tue Sep 29 12:15:31 -0400 2009</span>
</div>
</div>
<div id='content'>
Expand Down
4 changes: 2 additions & 2 deletions doc/files/lib/ardes/active_record/saved_rb.html
@@ -1,7 +1,7 @@
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/strict.dtd">
<html lang='en'>
<head>
<title>File: saved.rb [Resources Controller API Documentation (2c87336)]</title>
<title>File: saved.rb [Resources Controller API Documentation (14a40aa)]</title>
<meta content='text/html; charset=utf-8' http-equiv='Content-Type'>
<link href='../../../../rdoc-style.css' media='screen' rel='stylesheet' type='text/css'>
<script type='text/javascript'>
Expand Down Expand Up @@ -31,7 +31,7 @@ <h1 class='name'>saved.rb</h1>
</div>
<div class='last-update'>
Last Update:
<span class='datetime'>Tue Sep 29 09:38:02 +0100 2009</span>
<span class='datetime'>Tue Sep 29 12:15:31 -0400 2009</span>
</div>
</div>
<div id='content'>
Expand Down
4 changes: 2 additions & 2 deletions doc/files/lib/ardes/resources_controller/actions_rb.html
@@ -1,7 +1,7 @@
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/strict.dtd">
<html lang='en'>
<head>
<title>File: actions.rb [Resources Controller API Documentation (2c87336)]</title>
<title>File: actions.rb [Resources Controller API Documentation (14a40aa)]</title>
<meta content='text/html; charset=utf-8' http-equiv='Content-Type'>
<link href='../../../../rdoc-style.css' media='screen' rel='stylesheet' type='text/css'>
<script type='text/javascript'>
Expand Down Expand Up @@ -31,7 +31,7 @@ <h1 class='name'>actions.rb</h1>
</div>
<div class='last-update'>
Last Update:
<span class='datetime'>Tue Sep 29 09:38:02 +0100 2009</span>
<span class='datetime'>Tue Sep 29 12:15:31 -0400 2009</span>
</div>
</div>
<div id='content'>
Expand Down
4 changes: 2 additions & 2 deletions doc/files/lib/ardes/resources_controller/helper_rb.html
@@ -1,7 +1,7 @@
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/strict.dtd">
<html lang='en'>
<head>
<title>File: helper.rb [Resources Controller API Documentation (2c87336)]</title>
<title>File: helper.rb [Resources Controller API Documentation (14a40aa)]</title>
<meta content='text/html; charset=utf-8' http-equiv='Content-Type'>
<link href='../../../../rdoc-style.css' media='screen' rel='stylesheet' type='text/css'>
<script type='text/javascript'>
Expand Down Expand Up @@ -31,7 +31,7 @@ <h1 class='name'>helper.rb</h1>
</div>
<div class='last-update'>
Last Update:
<span class='datetime'>Tue Sep 29 09:38:02 +0100 2009</span>
<span class='datetime'>Tue Sep 29 12:15:31 -0400 2009</span>
</div>
</div>
<div id='content'>
Expand Down
@@ -1,7 +1,7 @@
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/strict.dtd">
<html lang='en'>
<head>
<title>File: include_actions.rb [Resources Controller API Documentation (2c87336)]</title>
<title>File: include_actions.rb [Resources Controller API Documentation (14a40aa)]</title>
<meta content='text/html; charset=utf-8' http-equiv='Content-Type'>
<link href='../../../../rdoc-style.css' media='screen' rel='stylesheet' type='text/css'>
<script type='text/javascript'>
Expand Down Expand Up @@ -31,7 +31,7 @@ <h1 class='name'>include_actions.rb</h1>
</div>
<div class='last-update'>
Last Update:
<span class='datetime'>Tue Sep 29 09:38:02 +0100 2009</span>
<span class='datetime'>Tue Sep 29 12:15:31 -0400 2009</span>
</div>
</div>
<div id='content'>
Expand Down
@@ -1,7 +1,7 @@
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/strict.dtd">
<html lang='en'>
<head>
<title>File: named_route_helper.rb [Resources Controller API Documentation (2c87336)]</title>
<title>File: named_route_helper.rb [Resources Controller API Documentation (14a40aa)]</title>
<meta content='text/html; charset=utf-8' http-equiv='Content-Type'>
<link href='../../../../rdoc-style.css' media='screen' rel='stylesheet' type='text/css'>
<script type='text/javascript'>
Expand Down Expand Up @@ -31,7 +31,7 @@ <h1 class='name'>named_route_helper.rb</h1>
</div>
<div class='last-update'>
Last Update:
<span class='datetime'>Tue Sep 29 09:38:02 +0100 2009</span>
<span class='datetime'>Tue Sep 29 12:15:31 -0400 2009</span>
</div>
</div>
<div id='content'>
Expand Down

0 comments on commit 35777a7

Please sign in to comment.