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

Remove README include from normal build #123

Open
TerryRPatterson opened this issue Jul 21, 2024 · 0 comments
Open

Remove README include from normal build #123

TerryRPatterson opened this issue Jul 21, 2024 · 0 comments

Comments

@TerryRPatterson
Copy link

I am messing around with packaging ariadne as a rpm.
By default README files are marked as doc files which are
often excluded from installation in automated installs.
This results in compilation of lib.rs failing as it can't include
README.

Would it be possible to make the include_str conditional?
Something like #![cfg_attr(doc, doc = include_str!("../README.md"))]

I tried to write a small PR for this but I ended up running into the #![deny(missing_docs)].
The lint could be addressed with another doc macro like:
#![cfg_attr(not(doc), doc="Module docs excluded from non doc build")]
but I am not sure if y'all would be okay with that change.

Would y'all be okay with a change like that?

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

No branches or pull requests

1 participant