Skip to content

:stopdoc: can prevent indexing a class documented in another file #398

Closed

Description

@halostatue

When working on cartage 2.0, I found a case where the improper placement of the :stopdoc: directive can prevent the indexing of a class documented in another file. I have created a minimal reproduction and workaround as a gist.

My specific use-case was that I have a file that implements #dig for RUBY_VERSION < '2.3'. I don’t want any of that documented because its presence is incidental to the main gem.

Funnily enough, this may be related to the fix in #55 mentioned in the guidelines for contributing.

Activity

  1. nobu commented on Oct 27, 2018

    @nobu
    Member

    Probably I encountered this bug while generating ruby's NEWS.html, and made a workaround.

  2. added a commit that references this issue on Feb 17, 2026
    78ca6f5
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions