You are viewing a plain text version of this content. The canonical link for it is here.
Posted to github@datafusion.apache.org by "Rafferty97 (via GitHub)" <gi...@apache.org> on 2024/07/28 12:04:04 UTC
[I] Improve doc comments inside macros [datafusion]
Rafferty97 opened a new issue, #11692:
URL: https://github.com/apache/datafusion/issues/11692
## Summary
Some items defined within macros use macro tokens like `$UDF` within their doc comments, which render as that literal string in cargo documentation, which is confusing and looks a little broken. Here's an example:
https://docs.rs/datafusion/latest/datafusion/functions/math/fn.cot.html
## Proposal
Use a combination of `#[doc]`, `concat!` and `stringify!` to properly interpolate relevant type names into the generated doc comments.
--
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.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: [I] Improve doc comments inside macros [datafusion]
Posted by "alamb (via GitHub)" <gi...@apache.org>.
alamb closed issue #11692: Improve doc comments inside macros
URL: https://github.com/apache/datafusion/issues/11692
--
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: [I] Improve doc comments inside macros [datafusion]
Posted by "alamb (via GitHub)" <gi...@apache.org>.
alamb closed issue #11692: Improve doc comments inside macros
URL: https://github.com/apache/datafusion/issues/11692
--
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