You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
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?
The text was updated successfully, but these errors were encountered:
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 includeREADME.
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?
The text was updated successfully, but these errors were encountered: