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

Wiki to doc tests #121

Merged
merged 3 commits into from
Oct 6, 2020
Merged

Conversation

mike-kfed
Copy link
Contributor

second attempt to fix issue #115

I did not include the example using structopt since that does not compile on your CI tests.

the link to the attributes page of the wiki remains. didn't figure out where to put this in the code (maybe extra rust source file that is just documentation?)

@mike-kfed mike-kfed mentioned this pull request Oct 6, 2020
@jplatte
Copy link
Contributor

jplatte commented Oct 6, 2020

the link to the attributes page of the wiki remains. didn't figure out where to put this in the code (maybe extra rust source file that is just documentation?)

I think what you could do for attributes is have one .md file per attribute that describes that attribute, and add

///
/// # Attributes
///
#[doc(include("attr_foo.md"))]
#[doc(include("attr_bat.md"))]

at the end of the docs for every drive macro that supports a set of attributes.

@mike-kfed
Copy link
Contributor Author

while a good idea, this is experimental see rust-lang/rust#44732

I'd rather wait for this to be stabilised.

@jplatte
Copy link
Contributor

jplatte commented Oct 6, 2020

Oh, I thought that was stable. In that case I might make a PR adding sth like this behind a feature flag later but that probably shouldn't block the current work.

@Peternator7
Copy link
Owner

This is super great! Thanks for taking on this work. I'll merge it and push a patch version to crates today so docs.rs picks up the new version.

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

Successfully merging this pull request may close these issues.

3 participants