@@ -33,7 +33,7 @@ The schema comment looks like this:
3333 . . .
3434
3535It also annotates geometrical columns, geom type and srid, when using
36- ` SpatialAdapter`, ` PostgisAdapter` or ` PostGISAdapter` :
36+ + SpatialAdapter+, + PostgisAdapter+ or + PostGISAdapter+ :
3737
3838 # == Schema Info
3939 #
@@ -43,7 +43,7 @@ It also annotates geometrical columns, geom type and srid, when using
4343 # path :geometry line_string, 4326
4444
4545Also, if you pass the -r option, it'll annotate routes.rb with the output of
46- ` rake routes` .
46+ + rake routes+ .
4747
4848
4949== Install
@@ -70,7 +70,7 @@ Into environment gems from Github checkout:
7070
7171== Usage
7272
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+ .)
7474
7575=== Usage in Rails
7676
@@ -105,9 +105,9 @@ To remove routes.rb annotations:
105105
106106=== Usage Outside of Rails
107107
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
111111project and help it bootstrap and load the relevant code.
112112
113113
@@ -121,7 +121,7 @@ anywhere in the file:
121121
122122=== Configuration in Rails
123123
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
125125default options:
126126
127127 rails g annotate:install
@@ -132,8 +132,8 @@ added (top or bottom of file), and in which artifacts.
132132== Rails Integration
133133
134134By 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
137137change:
138138
139139 'skip_on_db_migrate' => "false",
142142
143143 'skip_on_db_migrate' => "true",
144144
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,
146146you can do so with a simple environment variable, instead of editing the
147- ` .rake` file:
147+ + .rake+ file:
148148
149149 skip_on_db_migrate=1 rake db:migrate
150150
@@ -188,21 +188,21 @@ migrations were run).
188188
189189If you prefer to sort alphabetically so that the results of
190190annotation are consistent regardless of what order migrations are executed in,
191- use --sort.
191+ use + --sort+ .
192192
193193
194194== Markdown
195195
196196The 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:
201201
202202 --markup markdown
203203 --markup-provider kramdown
204204
205- Be sure to add this to your ` Gemfile` as well:
205+ Be sure to add this to your + Gemfile+ as well:
206206
207207 gem 'kramdown', :groups => [:development], :require => false
208208
@@ -214,7 +214,7 @@ will blow away the initial/final comment block in your models if it looks like
214214it was previously added by this gem.
215215
216216Be 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+ :
218218
219219 $ git status
220220
@@ -244,4 +244,3 @@ Released under the same license as Ruby. No Support. No Warranty.
244244== Authors
245245
246246{See AUTHORS.rdoc}[link:AUTHORS.rdoc].
247-
0 commit comments