Project

General

Profile

« Previous | Next » 

Revision 64f9f7d8

Added by burdettelamar (Burdette Lamar) over 3 years ago

[ruby/rdoc] [DOC] Clarifications for directives (https://github.com/ruby/rdoc/pull/903)

  • Former section "Directives in Trailing Comments" is reworked. The important thing about a directive is what it does, not whether it's trailing or stand-alone. Therefore I've worked the directives in the former section into the appropriate sections, based on function.
  • Each directive is now explicitly marked as trailing or stand-alone.
  • C-code directives are mentioned only for those directives that actually appear in our ruby/ruby C files, which are :startdoc:, :stopdoc:, :enddoc:, :include:, and :call-seq:. What effect, if any, other directives have in C, I'm not sure about.

https://github.com/ruby/rdoc/commit/b00978bfa5