doc-comment

doc-comment copied to clipboard

Expose generated modules as public

7

I have a snippet like this: ```rs pub struct User { username: String } ``` Included using doctest like this: ```rs // In module docs.rs doctest!("doc/users.md", users); ``` Now in...

raffomania

Include multiple files from a directory

1

I have a folder full of documentation I'd like to test using `doc_comment`. At the moment, I have to include every file explicitly: ```rs doctest!("../docs/README.md"); doctest!("../docs/conventions.md"); doctest!("../docs/database.md"); doctest!("../docs/testing/mocks.md"); // ......

raffomania

No tags per release?

2

Adding those is quite helpful for checking out old versions and compare lib versions as well.

qrilka

Documentation should make it clear where to put `doctest!`

6

I was adding this crate to my library like this: `tests/readme.rs`: ``` use doc_comment::doctest; doctest!("../README.md"); ``` And I added an error into the code in README to see if it...

robinst

Hey, you currently have no git tag equivalents to releases. I think it's always nice to be able to quickly compare version information between releases so it'd be cool if...

svenstaro

@GuillaumeGomez are there reasons for this project to use edition 2015? According to [the Edition Guide](https://doc.rust-lang.org/edition-guide/editions/index.html): > if you're using Rust 2015, and one of your dependencies uses Rust 2018,...

Veetaha

Add doc_compile macro to compile external files only.

8

I want to guarantee all examples in external files can pass compiling. The main reason not to add `no_run` for each block is many markdown renders cannot correctly recognize a...

Hexilee

Is there a way to create inner attributes (`#![doc(…)]`)?

11

I’d like to include module-level documentation.

shepmaster