ensure authors get warnings about broken links, and ensure end users …

…don't
rails · Mar 22, 2009 · 1ff3ae3 · 1ff3ae3
1 parent dab7813
commit 1ff3ae3
Show file tree

Hide file tree

Showing 2 changed files with 2 additions and 1 deletion.
diff --git a/railties/Rakefile b/railties/Rakefile
@@ -247,6 +247,7 @@ end
 
 desc 'Generate guides (for authors), use ONLY=foo to process just "foo.textile"'
 task :guides do
+  ENV["WARN_BROKEN_LINKS"] = "1" # authors can't disable this
   ruby "guides/rails_guides.rb"
 end
 

diff --git a/railties/guides/rails_guides/generator.rb b/railties/guides/rails_guides/generator.rb
@@ -164,7 +164,7 @@ def check_fragment_identifiers(html, anchors)
           guess = anchors.min { |a, b|
             Levenshtein.distance(fragment_identifier, a) <=> Levenshtein.distance(fragment_identifier, b)
           }
-          puts "*** BROKEN LINK: ##{fragment_identifier}, perhaps you meant ##{guess}."
+          puts "*** BROKEN LINK: ##{fragment_identifier}, perhaps you meant ##{guess}." if ENV.key?("WARN_BROKEN_LINKS")
         end
       end
     end