Skip to content
This repository

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Browse code

Number all RDoc section titles in Dataset and Database classes

hanna-nouveau sorts by section title, so the RDoc will finally
display sections in a sensible order.
  • Loading branch information...
commit 927a2cc33e64a198d96c47181dd3a6c7a3aeb937 1 parent 38e8924
Jeremy Evans authored July 17, 2011
2  lib/sequel/database/connecting.rb
... ...
@@ -1,7 +1,7 @@
1 1
 module Sequel
2 2
   class Database
3 3
     # ---------------------
4  
-    # :section: Methods relating to adapters, connecting, disconnecting, and sharding
  4
+    # :section: 4 - Methods relating to adapters, connecting, disconnecting, and sharding
5 5
     # This methods involve the Database's connection pool.
6 6
     # ---------------------
7 7
 
2  lib/sequel/database/dataset.rb
... ...
@@ -1,7 +1,7 @@
1 1
 module Sequel
2 2
   class Database
3 3
     # ---------------------
4  
-    # :section: Methods that create datasets
  4
+    # :section: 3 - Methods that create datasets
5 5
     # These methods all return instances of this database's dataset class.
6 6
     # ---------------------
7 7
 
2  lib/sequel/database/dataset_defaults.rb
... ...
@@ -1,7 +1,7 @@
1 1
 module Sequel
2 2
   class Database
3 3
     # ---------------------
4  
-    # :section: Methods that set defaults for created datasets
  4
+    # :section: 5 - Methods that set defaults for created datasets
5 5
     # This methods change the default behavior of this database's datasets.
6 6
     # ---------------------
7 7
 
2  lib/sequel/database/logging.rb
... ...
@@ -1,7 +1,7 @@
1 1
 module Sequel
2 2
   class Database
3 3
     # ---------------------
4  
-    # :section: Methods relating to logging
  4
+    # :section: 6 - Methods relating to logging
5 5
     # This methods affect relating to the logging of executed SQL.
6 6
     # ---------------------
7 7
 
2  lib/sequel/database/misc.rb
... ...
@@ -1,7 +1,7 @@
1 1
 module Sequel
2 2
   class Database
3 3
     # ---------------------
4  
-    # :section: Miscellaneous methods
  4
+    # :section: 7 - Miscellaneous methods
5 5
     # These methods don't fit neatly into another category.
6 6
     # ---------------------
7 7
 
2  lib/sequel/database/query.rb
... ...
@@ -1,7 +1,7 @@
1 1
 module Sequel
2 2
   class Database
3 3
     # ---------------------
4  
-    # :section: Methods that execute queries and/or return results
  4
+    # :section: 1 - Methods that execute queries and/or return results
5 5
     # This methods generally execute SQL code on the database server.
6 6
     # ---------------------
7 7
 
2  lib/sequel/database/schema_methods.rb
... ...
@@ -1,7 +1,7 @@
1 1
 module Sequel
2 2
   class Database
3 3
     # ---------------------
4  
-    # :section: Methods that modify the database schema
  4
+    # :section: 2 - Methods that modify the database schema
5 5
     # These methods execute code on the database that modifies the database's schema.
6 6
     # ---------------------
7 7
 
2  lib/sequel/dataset/actions.rb
... ...
@@ -1,7 +1,7 @@
1 1
 module Sequel
2 2
   class Dataset
3 3
     # ---------------------
4  
-    # :section: Methods that execute code on the database
  4
+    # :section: 2 - Methods that execute code on the database
5 5
     # These methods all execute the dataset's SQL on the database.
6 6
     # They don't return modified datasets, so if used in a method chain
7 7
     # they should be the last method called.
2  lib/sequel/dataset/features.rb
... ...
@@ -1,7 +1,7 @@
1 1
 module Sequel
2 2
   class Dataset
3 3
     # ---------------------
4  
-    # :section: Methods that describe what the dataset supports
  4
+    # :section: 4 - Methods that describe what the dataset supports
5 5
     # These methods all return booleans, with most describing whether or not the
6 6
     # dataset supports a feature.
7 7
     # ---------------------
2  lib/sequel/dataset/graph.rb
... ...
@@ -1,7 +1,7 @@
1 1
 module Sequel
2 2
   class Dataset
3 3
     # ---------------------
4  
-    # :section: Methods related to dataset graphing
  4
+    # :section: 5 - Methods related to dataset graphing
5 5
     # Dataset graphing changes the dataset to yield hashes where keys are table
6 6
     # name symbols and values are hashes representing the columns related to
7 7
     # that table.  All of these methods return modified copies of the receiver.
2  lib/sequel/dataset/misc.rb
... ...
@@ -1,7 +1,7 @@
1 1
 module Sequel
2 2
   class Dataset
3 3
     # ---------------------
4  
-    # :section: Miscellaneous methods
  4
+    # :section: 6 - Miscellaneous methods
5 5
     # These methods don't fit cleanly into another section.
6 6
     # ---------------------
7 7
     
2  lib/sequel/dataset/mutation.rb
... ...
@@ -1,7 +1,7 @@
1 1
 module Sequel
2 2
   class Dataset
3 3
     # ---------------------
4  
-    # :section: Mutation methods
  4
+    # :section: 7 - Mutation methods
5 5
     # These methods modify the receiving dataset and should be used with care.
6 6
     # ---------------------
7 7
     
2  lib/sequel/dataset/prepared_statements.rb
... ...
@@ -1,7 +1,7 @@
1 1
 module Sequel 
2 2
   class Dataset
3 3
     # ---------------------
4  
-    # :section: Methods related to prepared statements or bound variables
  4
+    # :section: 8 - Methods related to prepared statements or bound variables
5 5
     # On some adapters, these use native prepared statements and bound variables, on others
6 6
     # support is emulated.  For details, see the {"Prepared Statements/Bound Variables" guide}[link:files/doc/prepared_statements_rdoc.html].
7 7
     # ---------------------
2  lib/sequel/dataset/query.rb
... ...
@@ -1,7 +1,7 @@
1 1
 module Sequel
2 2
   class Dataset
3 3
     # ---------------------
4  
-    # :section: Methods that return modified datasets
  4
+    # :section: 1 - Methods that return modified datasets
5 5
     # These methods all return modified copies of the receiver.
6 6
     # ---------------------
7 7
 
4  lib/sequel/dataset/sql.rb
... ...
@@ -1,7 +1,7 @@
1 1
 module Sequel
2 2
   class Dataset
3 3
     # ---------------------
4  
-    # :section: User Methods relating to SQL Creation
  4
+    # :section: 3 - User Methods relating to SQL Creation
5 5
     # These are methods you can call to see what SQL will be generated by the dataset.
6 6
     # ---------------------
7 7
     
@@ -163,7 +163,7 @@ def update_sql(values = {})
163 163
     end
164 164
     
165 165
     # ---------------------
166  
-    # :section: Internal Methods relating to SQL Creation
  166
+    # :section: 9 - Internal Methods relating to SQL Creation
167 167
     # These methods, while public, are not designed to be used directly by the end user.
168 168
     # ---------------------
169 169
     

0 notes on commit 927a2cc

Please sign in to comment.
Something went wrong with that request. Please try again.