Skip to content

Revise the warning in the README #123

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Aug 15, 2013
Merged

Revise the warning in the README #123

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 9 additions & 4 deletions README.rdoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -217,12 +217,17 @@ Be sure to add this to your `Gemfile` as well:

== WARNING

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

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

$ git status

If you are not using a VCS (like Git, Subversion or similar), please tread
extra carefully, and consider using one.

== Links

Expand Down