@@ -33,7 +33,7 @@ The schema comment looks like this:
33
33
. . .
34
34
35
35
It also annotates geometrical columns, geom type and srid, when using
36
- ` SpatialAdapter`, ` PostgisAdapter` or ` PostGISAdapter` :
36
+ + SpatialAdapter+, + PostgisAdapter+ or + PostGISAdapter+ :
37
37
38
38
# == Schema Info
39
39
#
@@ -43,7 +43,7 @@ It also annotates geometrical columns, geom type and srid, when using
43
43
# path :geometry line_string, 4326
44
44
45
45
Also, if you pass the -r option, it'll annotate routes.rb with the output of
46
- ` rake routes` .
46
+ + rake routes+ .
47
47
48
48
49
49
== Install
@@ -70,7 +70,7 @@ Into environment gems from Github checkout:
70
70
71
71
== Usage
72
72
73
- (If you used the Gemfile install, prefix the below commands with ` bundle exec` .)
73
+ (If you used the Gemfile install, prefix the below commands with + bundle exec+ .)
74
74
75
75
=== Usage in Rails
76
76
@@ -105,9 +105,9 @@ To remove routes.rb annotations:
105
105
106
106
=== Usage Outside of Rails
107
107
108
- Everything above applies, except that --routes is not meaningful, and you will
109
- probably need to explicitly set one or more ` --require` option(s), and/or one
110
- or more ` --model-dir` options to inform annotate about the structure of your
108
+ Everything above applies, except that + --routes+ is not meaningful, and you will
109
+ probably need to explicitly set one or more + --require+ option(s), and/or one
110
+ or more + --model-dir+ options to inform annotate about the structure of your
111
111
project and help it bootstrap and load the relevant code.
112
112
113
113
@@ -121,7 +121,7 @@ anywhere in the file:
121
121
122
122
=== Configuration in Rails
123
123
124
- To generate a configuration file (in the form of a ` .rake` file), to set
124
+ To generate a configuration file (in the form of a + .rake+ file), to set
125
125
default options:
126
126
127
127
rails g annotate:install
@@ -132,8 +132,8 @@ added (top or bottom of file), and in which artifacts.
132
132
== Rails Integration
133
133
134
134
By default, once you've generated a configuration file, annotate will be
135
- executed whenever you run ` rake db:migrate` (but only in development mode).
136
- If you want to disable this behavior permanently, edit the ` .rake` file and
135
+ executed whenever you run + rake db:migrate+ (but only in development mode).
136
+ If you want to disable this behavior permanently, edit the + .rake+ file and
137
137
change:
138
138
139
139
'skip_on_db_migrate' => "false",
142
142
143
143
'skip_on_db_migrate' => "true",
144
144
145
- If you want to run ` rake db:migrate` as a one-off without running annotate,
145
+ If you want to run + rake db:migrate+ as a one-off without running annotate,
146
146
you can do so with a simple environment variable, instead of editing the
147
- ` .rake` file:
147
+ + .rake+ file:
148
148
149
149
skip_on_db_migrate=1 rake db:migrate
150
150
@@ -188,21 +188,21 @@ migrations were run).
188
188
189
189
If you prefer to sort alphabetically so that the results of
190
190
annotation are consistent regardless of what order migrations are executed in,
191
- use --sort.
191
+ use + --sort+ .
192
192
193
193
194
194
== Markdown
195
195
196
196
The format produced is actually MultiMarkdown, making use of the syntax
197
- extension for tables. It's recommended you use ` kramdown` as your parser if
198
- you want to use this format. If you're using ` yard` to generate documentation,
199
- specify a format of markdown with ` kramdown` as the provider by adding this to
200
- your ` .yardopts` file:
197
+ extension for tables. It's recommended you use + kramdown+ as your parser if
198
+ you want to use this format. If you're using + yard+ to generate documentation,
199
+ specify a format of markdown with + kramdown+ as the provider by adding this to
200
+ your + .yardopts+ file:
201
201
202
202
--markup markdown
203
203
--markup-provider kramdown
204
204
205
- Be sure to add this to your ` Gemfile` as well:
205
+ Be sure to add this to your + Gemfile+ as well:
206
206
207
207
gem 'kramdown', :groups => [:development], :require => false
208
208
@@ -214,7 +214,7 @@ will blow away the initial/final comment block in your models if it looks like
214
214
it was previously added by this gem.
215
215
216
216
Be sure to check the changes that this tool makes! If you are using Git,
217
- you may simply check your project's status after running ` annotate` :
217
+ you may simply check your project's status after running + annotate+ :
218
218
219
219
$ git status
220
220
@@ -244,4 +244,3 @@ Released under the same license as Ruby. No Support. No Warranty.
244
244
== Authors
245
245
246
246
{See AUTHORS.rdoc}[link:AUTHORS.rdoc].
247
-
0 commit comments