# Is the problem with me or with the documentation?

**URL:** <https://www.ruby-forum.com/t/is-the-problem-with-me-or-with-the-documentation/197678>\
**Category:** Ruby\
**Created:** [October 18, 2010, 8:10pm UTC](https://www.ruby-forum.com/t/is-the-problem-with-me-or-with-the-documentation/197678 "2010-10-18T20:10:47Z")\
**Posts on this page:** 1\
**Page:** 1

<div class="post-metadata">

**Author:** ![Dobai-Pataky\_BSSSSl](https://www.ruby-forum.com/letter_avatar_proxy/v4/letter/d/77aa72/32.png) [@Dobai-Pataky\_BSSSSl](https://www.ruby-forum.com/u/Dobai-Pataky_BSSSSl)\
**Post date:** [October 18, 2010, 8:10pm UTC](https://www.ruby-forum.com/t/is-the-problem-with-me-or-with-the-documentation/197678/1 "2010-10-18T20:10:47Z")

</div>

The Sinatra FAQ makes mention of the “escape\_html()” method of  
Rack::Utils. It links to the Rack::Utils documentation,  
[http://rack.rubyforge.org/doc/classes/Rack/Utils.html](http://rack.rubyforge.org/doc/classes/Rack/Utils.html) , but this page  
has no mention of escape\_html(). Digging into the source code of  
lib/rack/utils.rb, however, I am able to find escape\_html().

So my question is: why doesn’t the documentation mention this method? Am  
I looking in the wrong place? I expect Ruby library documentation to  
often be lacking meaningful description (sadly), but this method isn’t  
mentioned at all! Isn’t ruby documentation auto-generated from the  
source code? Shouldn’t that automatically cause existence of this method  
be mentioned in the docs?