Skip to content

Do something sensible with rustdoc/demo.rs #3731

Description

@catamorphism

FIXME says "It would be nice if we could run some automated tests on this file". Now that include_str exists, that's possible.

Activity

  1. pnkfelix commented on Jun 12, 2013

    @pnkfelix
    Contributor

    @catamorphism is your thinking here that we would automatically include the contents of demo.rs into another file that applies some functions from librustdoc to the included text, just to ensure that nothing hangs/segfaults? Or was there some strategy for checking that the documentation output conforms to some expected value?

    (I'm in part trying to understand why include_str was the missing piece of the puzzle ... the kinds of tests I was imagining seem like they would work with files just as well as with included-strings.

    (I know you didn't write the original comment, so if you don't have an idea of what the intention was, feel free to say so. :)

  2. catamorphism commented on Jun 12, 2013

    @catamorphism
    ContributorAuthor

    @pnkfelix Hmm, I no longer remember what I was talking about :-) Your reasoning seems sound to me.

  3. emberian commented on Aug 5, 2013

    @emberian
    Contributor

    Subsuming under rustdoc_ng; closing.

  4. added a commit that references this issue on Jul 4, 2024
  5. added a commit that references this issue on Aug 21, 2026
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

    A-testsuiteArea: The testsuite used to check the correctness of rustcT-rustdocRelevant to the rustdoc team, which will review and decide on the PR/issue.

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions