Stream: rustdoc

Topic: Doctests on private macros


view this post on Zulip inquisitivecrystal (Aug 14 2021 at 06:53):

I have an interesting problem for y'all. I'm hitting an error in #88019 because the changes I'm making there lead to doctests running on non-exported macros. Previously, doctests were only run on exported macros. I'm not entirely sure what to do about it. Keeping the old behavior is trivial, but it may not be desirable. After all, it's probably bad for the tests to silently be ignored, particularly when that doesn't match with the behavior for other private items. At the same time, starting to run them is backwards incompatible, as the error I'm getting demonstrates.

view this post on Zulip inquisitivecrystal (Aug 14 2021 at 06:58):

The simplest thing to do is probably to leave a FIXME. Then, in future. someone can make it so that the test generates a warning but doesn't actually fail.

view this post on Zulip Joshua Nelson (Aug 14 2021 at 14:25):

I think a FIXME is a good idea, that makes it less likely we have to revert. That said I definitely think we should run these tests, for two reasons:


Last updated: Oct 21 2021 at 21:32 UTC