You are viewing a plain text version of this content. The canonical link for it is here.
Posted to github@datafusion.apache.org by "alamb (via GitHub)" <gi...@apache.org> on 2024/04/26 17:45:38 UTC
[PR] Fix docs.rs build for datafusion-proto [datafusion]
alamb opened a new pull request, #10254:
URL: https://github.com/apache/datafusion/pull/10254
## Which issue does this PR close?
Closes https://github.com/apache/datafusion/issues/10163
## Rationale for this change
Docs.rs is broken failed for https://docs.rs/crate/datafusion-proto/latest
The build has a log https://docs.rs/crate/datafusion-proto/37.0.0/builds/1179419 shows the error that the `generated` module isn't working
## What changes are included in this PR?
Remove cfg to get working again (maybe)
## Are these changes tested?
No -- I don't know how to test them. In the other hands the docs are broken so this isn't going to make them any more broken 🤷
## Are there any user-facing changes?
<!--
If there are user-facing changes then we may require documentation to be updated before approving the PR.
-->
<!--
If there are any breaking changes to public APIs, please add the `api change` label.
-->
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: github-unsubscribe@datafusion.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: github-unsubscribe@datafusion.apache.org
For additional commands, e-mail: github-help@datafusion.apache.org
Re: [PR] Fix docs.rs build for datafusion-proto (hopefully) [datafusion]
Posted by "alamb (via GitHub)" <gi...@apache.org>.
alamb commented on PR #10254:
URL: https://github.com/apache/datafusion/pull/10254#issuecomment-2085297925
> A command that tests this is: `cargo +nightly rustdoc --config 'build.rustdocflags=["--cfg", "docsrs", "--cap-lints", "warn"]'`
>
> I took this from the [docs.rs build logs](https://docs.rs/crate/datafusion-proto/37.1.0/builds). By running locally, I can confirm that this patch fixes the docs build.
Thank you @leoyvens -- that is quite clever.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: github-unsubscribe@datafusion.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: github-unsubscribe@datafusion.apache.org
For additional commands, e-mail: github-help@datafusion.apache.org
Re: [PR] Fix docs.rs build for datafusion-proto (hopefully) [datafusion]
Posted by "comphead (via GitHub)" <gi...@apache.org>.
comphead merged PR #10254:
URL: https://github.com/apache/datafusion/pull/10254
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: github-unsubscribe@datafusion.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: github-unsubscribe@datafusion.apache.org
For additional commands, e-mail: github-help@datafusion.apache.org
Re: [PR] Fix docs.rs build for datafusion-proto [datafusion]
Posted by "alamb (via GitHub)" <gi...@apache.org>.
alamb commented on code in PR #10254:
URL: https://github.com/apache/datafusion/pull/10254#discussion_r1581342841
##########
datafusion/proto/src/generated/mod.rs:
##########
@@ -17,7 +17,6 @@
#[allow(clippy::all)]
#[rustfmt::skip]
-#[cfg(not(docsrs))]
Review Comment:
I think this was added in https://github.com/apache/datafusion/pull/3580 but now that the code is vendored (doesn't require running protoc at compile time) I think it should work
However, I don't really understand why it stopped working in the first place 🤔
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: github-unsubscribe@datafusion.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: github-unsubscribe@datafusion.apache.org
For additional commands, e-mail: github-help@datafusion.apache.org
Re: [PR] Fix docs.rs build for datafusion-proto (hopefully) [datafusion]
Posted by "leoyvens (via GitHub)" <gi...@apache.org>.
leoyvens commented on PR #10254:
URL: https://github.com/apache/datafusion/pull/10254#issuecomment-2080763530
A command that tests this is:
`cargo +nightly rustdoc --config 'build.rustdocflags=["--cfg", "docsrs", "--cap-lints", "warn"]'`
I took this from the [docs.rs build logs](https://docs.rs/crate/datafusion-proto/37.1.0/builds). By running locally, I can confirm that this patch fixes the docs build.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: github-unsubscribe@datafusion.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: github-unsubscribe@datafusion.apache.org
For additional commands, e-mail: github-help@datafusion.apache.org