Skip to content

Commit 04609d2

Browse files
committed
Revise the warning in the README
See #122. I've revised the wording to placing the important text in the first sentence, and made the warning a bit more 2013-like by referencing VCS instead of backing files up.
1 parent 8bd159c commit 04609d2

File tree

1 file changed

+9
-4
lines changed

1 file changed

+9
-4
lines changed

README.rdoc

Lines changed: 9 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -217,12 +217,17 @@ Be sure to add this to your `Gemfile` as well:
217217

218218
== WARNING
219219

220-
Note that this code will blow away the initial/final comment block in your
221-
models if it looks like it was previously added by this gem, so you don't want
222-
to add additional text to an automatically created comment block.
220+
<b>Don't add text after an automatically-created comment block.</b> This tool
221+
will blow away the initial/final comment block in your models if it looks like
222+
it was previously added by this gem.
223223

224-
BACK UP YOUR MODELS BEFORE USING THIS TOOL!
224+
Be sure to check the changes that this tool makes! If you are using Git,
225+
you may simply check your project's status after running `annotate`:
225226

227+
$ git status
228+
229+
If you are not using a VCS (like Git, Subversion or similar), please tread
230+
extra carefully, and consider using one.
226231

227232
== Links
228233

0 commit comments

Comments
 (0)