alamb commented on code in PR #13646:
URL: https://github.com/apache/datafusion/pull/13646#discussion_r1870577111
##########
datafusion/core/src/bin/print_functions_docs.rs:
##########
@@ -158,6 +158,23 @@ fn print_docs(
unreachable!()
};
+ // let attr_text = documentation.to_doc_attribute();
+ //
+ // let file_path = format!("{}.txt", name);
+ // if std::path::Path::new(&file_path).exists() {
+ // std::fs::remove_file(&file_path).unwrap();
Review Comment:
I agree a comment explaining what this is used for would be most helpful
##########
datafusion/doc/src/lib.rs:
##########
@@ -63,6 +63,88 @@ impl Documentation {
) -> DocumentationBuilder {
DocumentationBuilder::new(doc_section, description, syntax_example)
}
+
+ /// Output the `Documentation` struct in form of custom Rust documentation
attributes
+ pub fn to_doc_attribute(&self) -> String {
Review Comment:
Maybe it would also help helpful here to note this is to help migration to
doc comment attributes
--
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: [email protected]
For queries about this service, please contact Infrastructure at:
[email protected]
---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]
