How do I use code from the `tests` module within my doc-tests?

[sonic root]

I've written some code that models, amongst other things, a connection and communication between different processors. Thanks to #981431562786725948, I created an mpsc channel and was able to mock-up a mode of communication, thereby having some unit tests with which to work.

Now I've moved onto the documentation tests, and I was hoping to use the same code again. However, the doc-tests don't seem to find the tests module I've created, so I'm stuck.

It's as if anything annotated with #[cfg(test)] disappears while the doc-tests are run compiled.

(Complication: The test module uses std, while the rest of the crate does not.)

I tried replacing #[cfg(test)] with #[cfg(any(test, doc))], but to no avail.

[tough dock]

You have basically one option, use a custom cfg flag to enable the module and build your doctests with that cfg flag enabled

[tough dock]

And for this you would need a #![cfg_attr(not(test), no_std)] in the root to enable std when testing

[sonic root]

The latter already exists.

Though, from what I just read, there is such a thing as a doctest attribute.

[tough dock]

You could also just have the module always there but hidden from the docs

[sonic root]

But I included it, and it still doesn't work.

[tough dock]

I believe that's an unfinished feature

[sonic root]

CRAP.

[sonic root]

I thought of that, but… in that case, how could I enable no_std for half the code?

[tough dock]

Alright so another thing you can do is put all the code you need in a macro_rules then call it in each of your doc tests (hidden with #)

This is a common pattern

[sonic root]

…that actually sounds tolerable.

[tough dock]

And also hide the macro rules with a #[doc(hidden)]

[tough dock]

Though usually only for stuff doc tests need, not stuff unit tests also need