Skip to content

How to put invisible comment in included file? #1691

@BurdetteLamar

Description

@BurdetteLamar

Over at ruby/ruby/doc/examples/files.rdoc, we have some code that supports examples in IO, File, and now Pathname.

File files.rdoc is included elsewhere.

I'd like to put into it an invisible warning (comment) about changing the file, since others depend upon it so closely.

I've tried :stopdoc:/:startdoc: and =begin/=end. Even an HTML-style comment like .

Is there some way to make an invisible comment in an included .rdoc file.

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions