On Fri, May 12, 2006 at 02:37:31AM +0900, ara.t.howard / noaa.gov wrote:
> On Fri, 12 May 2006, Mauricio Fernandez wrote:
> >>you need to use
> >>
> >>  #--{{{ / #--}}}
> >>
> >>  #--{{{{ / #--}}}}
> >>
> >>or else the #{{{ totally horks rdoc.  fyi.
>
> dunno about the spaces - i think i arrived at #-- because that's some sort
> of flag for rdoc to ignore comments, so any such char should work.

Alright, I thought you meant that {{{ drove rdoc mad, when it's just that
they look bad in the docs :) (at least that's what it looks like after a
quick test).

rdoc/parsers/parse_rb.rb:
...
    def remove_private_comments(comment)
      comment.gsub!(/^#--.*?^#\+\+/m, '')
      comment.sub!(/^#--.*/m, '')
    end
...

So it seems things aren't that bad:
* nestable folds will do fine, since we can use e.g. #-- {{{{, also avoiding
  conflicts with your markers
* no problem either with "top-level" folds: anyway, there's no point in adding
  one just before a rdoc'able element (class, method...), since a fold would
  be created there automatically anyway.


Thanks for pointing this out, I'll add a few words about rdoc in the docs.


-- 
Mauricio Fernandez  -   http://eigenclass.org   -  singular Ruby