How to put invisible comment in included file?

Open
#1,691 2 comments 0 reactions 0 assignees View on GitHub

Maintainers usually reply within 1 day

Nobody has claimed this yet.

Assessment

Difficulty
3/5
Estimated time
1-2 days
Newbie friendliness
45/100
Issue type
Feature
Clarity
Mostly clear
Activity status
Quiet
Tech stack
ruby
Domain
documentation

Research direction

Start with ruby/ruby/doc/examples/files.rdoc and inspect how RDoc handles the attempted :stopdoc:/:startdoc:, =begin/=end, and HTML-style comment forms in included .rdoc files. Determine whether an existing syntax can hide the warning while preserving the included examples, or what behavior a supported solution should have; done means the warning is absent from generated documentation without affecting the examples.

Written by the indexing model from the issue text.

Description

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.

Dominant language
Ruby
Stars
930
Forks
472
Avg merge
2d 8h
Merged PRs (30d)
12

Getting set up

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from ruby/rdoc

All issues in ruby/rdoc

Similar issues

More Ruby issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.