Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

documented unit test that follows an undocumented symbol silently ignored #18994

Open
dlangBugzillaToGithub opened this issue May 26, 2015 · 1 comment

Comments

@dlangBugzillaToGithub
Copy link

Steven Schveighoffer (@schveiguy) reported this on 2015-05-26T18:02:06Z

Transferred from https://issues.dlang.org/show_bug.cgi?id=14622

Description

Consider this:

/// document foo
void foo(int) {...}

void foo(string) {...}

///
unittest
{
    // use foo like this!
    foo(1);
}

The unit test is not included in the documentation, because foo(string) was not ditto'd. But clearly, the unit test was supposed to be part of the documentation.

I propose we make a documented unit test that isn't attached to any symbol a warning when generating documentation.
@dlangBugzillaToGithub
Copy link
Author

dlang-bot commented on 2022-10-05T14:51:19Z

@ntrel created dlang/dmd pull request #14527 "Fix Issue 14622 - documented unit test following undocumented symbol" fixing this issue:

- Fix Issue 14622 - documented unit test following undocumented symbol

https://github.com/dlang/dmd/pull/14527

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

2 participants