Technically, you're right, they're unnecessary. However, we've chosen to
employ TomDoc for our internal documentation and these comments serve as
TomDoc formatting documentation.


On Wed, Jul 10, 2013 at 1:27 PM, Kelvin Raffael Stinghen <
notifications@github.com> wrote:

> In lib/jekyll/url.rb:
>
> > +    def url
> > +      @url ||= sanitize_url(permalink || generate_url)
> > +    end
> > +
> > +    # Generate the URL by replacing all placeholders with their respective values
> > +    #
> > +    # Returns the _unsanitizied_ String URL
> > +    def generate_url
> > +      url_placeholders.inject(template) { |result, token|
> > +        result.gsub(/:#{token.first}/, token.last)
> > +      }
> > +    end
> > +
> > +    # Returns a sanitized String URL
> > +    def sanitize_url(in_url)
> > +      # Remove all double slashes
>
> Just a self-opinion, some comments (especially those that only explain
> what the code does) are unnecessary like this and the others below...
>
> —
> Reply to this email directly or view it on GitHub<https://github.com/mojombo/jekyll/pull/944/files#r5122795>
> .
>