You are viewing a plain text version of this content. The canonical link for it is here.
Posted to github@datafusion.apache.org by "khushishukla2813 (via GitHub)" <gi...@apache.org> on 2025/03/03 19:38:50 UTC
[PR] Fix doc logo [datafusion]
khushishukla2813 opened a new pull request, #14989:
URL: https://github.com/apache/datafusion/pull/14989
## Which issue does this PR close?
- Closes #14796
## Rationale for this change
This change addresses an issue where inline crate-level documentation attributes (using `#![doc(...)]`) could not be generated via a procedural macro, resulting in errors like "inner attribute is not permitted in this context." By replacing these inline attributes with a centralized `doc_cfg!()` macro (defined via `macro_rules!`), we can manage the logo and favicon URLs in one place. This not only resolves the inner attribute issue but also improves maintainability.
## What changes are included in this PR?
- Removed the inline `#![doc(...)]` and `#![cfg_attr(...)]` attributes from `user_docs.rs`.
- Introduced a `doc_cfg!()` macro that centralizes the configuration of the documentation logo and favicon.
- Updated `user_docs.rs` to use the new macro (either by defining it directly in the file or by importing it from a separate module).
## Are these changes tested?
Yes, the changes have been tested locally by running `cargo doc` and verifying that the generated documentation correctly displays the updated logo and favicon. (Existing tests indirectly cover this change by ensuring the documentation builds without errors.)
## Are there any user-facing changes?
Yes, users will see the updated logo and favicon on the generated documentation pages. There are no functional changes to the API or underlying behavior—this is purely a documentation enhancement.
--
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 doc logo [datafusion]
Posted by "mbrobbel (via GitHub)" <gi...@apache.org>.
mbrobbel commented on code in PR #14989:
URL: https://github.com/apache/datafusion/pull/14989#discussion_r1978097980
##########
datafusion/macros/src/macros.rs:
##########
@@ -0,0 +1,10 @@
+#[macro_export]
Review Comment:
Unfortunately I don't think this works because:
```
error: cannot export macro_rules! macros from a `proc-macro` crate type currently
```
You could move the proc macros to a different crate and then re-export them in this crate, together with this macro maybe?
--
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 logo in rust API docs [datafusion]
Posted by "github-actions[bot] (via GitHub)" <gi...@apache.org>.
github-actions[bot] commented on PR #14989:
URL: https://github.com/apache/datafusion/pull/14989#issuecomment-2887964831
Thank you for your contribution. Unfortunately, this pull request is stale because it has been open 60 days with no activity. Please remove the stale label or comment or this will be closed in 7 days.
--
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 doc logo [datafusion]
Posted by "mbrobbel (via GitHub)" <gi...@apache.org>.
mbrobbel commented on code in PR #14989:
URL: https://github.com/apache/datafusion/pull/14989#discussion_r1978170890
##########
datafusion/macros/src/macros.rs:
##########
@@ -0,0 +1,10 @@
+#[macro_export]
Review Comment:
Maybe add a `proc-macros` crate, move the proc macros there and re-export them from the current macros crate?
--
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 logo in rust API docs [datafusion]
Posted by "alamb (via GitHub)" <gi...@apache.org>.
alamb commented on PR #14989:
URL: https://github.com/apache/datafusion/pull/14989#issuecomment-2715467041
Marking as draft as I think this PR is no longer waiting on feedback. Please mark it as ready for review when it is ready for another look
--
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 logo in rust API docs [datafusion]
Posted by "github-actions[bot] (via GitHub)" <gi...@apache.org>.
github-actions[bot] closed pull request #14989: Fix logo in rust API docs
URL: https://github.com/apache/datafusion/pull/14989
--
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 doc logo [datafusion]
Posted by "khushishukla2813 (via GitHub)" <gi...@apache.org>.
khushishukla2813 commented on code in PR #14989:
URL: https://github.com/apache/datafusion/pull/14989#discussion_r1978116941
##########
datafusion/macros/src/macros.rs:
##########
@@ -0,0 +1,10 @@
+#[macro_export]
Review Comment:
Yeah! that makes sense. I'll give it a try and see if it works. Do you have any suggestion on how to structure the crates for this....?
--
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 doc logo [datafusion]
Posted by "khushishukla2813 (via GitHub)" <gi...@apache.org>.
khushishukla2813 commented on code in PR #14989:
URL: https://github.com/apache/datafusion/pull/14989#discussion_r1979134788
##########
datafusion/macros/src/macros.rs:
##########
@@ -0,0 +1,10 @@
+#[macro_export]
Review Comment:
> Maybe add a `proc-macros` crate, move the proc macros there and re-export them from the current macros crate?
well ...I removed proc-macro = true so macro_rules! works from a normal library crate. Let me know if needs any other changes!"
--
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 doc logo [datafusion]
Posted by "alamb (via GitHub)" <gi...@apache.org>.
alamb commented on code in PR #14989:
URL: https://github.com/apache/datafusion/pull/14989#discussion_r1978171840
##########
datafusion/macros/src/macros.rs:
##########
@@ -0,0 +1,10 @@
+#[macro_export]
Review Comment:
https://crates.io/crates/datafusion-macros maybe
##########
datafusion/macros/src/macros.rs:
##########
@@ -0,0 +1,10 @@
+#[macro_export]
Review Comment:
https://crates.io/crates/datafusion-macros maybe
--
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 logo in rust API docs [datafusion]
Posted by "mbrobbel (via GitHub)" <gi...@apache.org>.
mbrobbel commented on code in PR #14989:
URL: https://github.com/apache/datafusion/pull/14989#discussion_r1988859166
##########
datafusion/macros/src/macros.rs:
##########
@@ -0,0 +1,10 @@
+#[macro_export]
Review Comment:
We also need the proc macros.
> Let me know if needs any other changes!
Can you please try to fix the 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