Doc gen: Migrate aggregate functions doc to attribute based. #13646
Conversation
github-actions
bot
added
documentation
| @@ -281,11 +281,11 @@ first_value(expression [ORDER BY expression]) | |||
| #### Example | |||
|
|
|||
| ```sql | |||
| > SELECT first_value(column_name ORDER BY other_column) FROM table_name; | |||
| > SELECT last_value(column_name ORDER BY other_column) FROM table_name; | |||
There was a problem hiding this comment.
the documentation fixed now.
There is an existing bug when documentation lock with the same name covers 2 or more doc functions in the same file. In this scenario documentation will pick the first available doc description which is unexpected. The migration to macros fixes the problem as it uses separate lock per function
| // | ||
| // let file_path = format!("{}.txt", name); | ||
| // if std::path::Path::new(&file_path).exists() { | ||
| // std::fs::remove_file(&file_path).unwrap(); |
There was a problem hiding this comment.
I'm thinking of leaving it for now as this part generates text files with attribute text so its easier to do a migration for remaning parts(windows/builtin udfs), semi automatic way instead of manual
There was a problem hiding this comment.
I would just add a small comment noting this is useful for migration purposes.
There was a problem hiding this comment.
I agree a comment explaining what this is used for would be most helpful
|
I'll do my best to look at this tonight or tomorrow but I'm juggling a lot atm. I am on vacation next week and I hope to be able to work on my backlog a bit then which currently stands at:
|
| // | ||
| // let file_path = format!("{}.txt", name); | ||
| // if std::path::Path::new(&file_path).exists() { | ||
| // std::fs::remove_file(&file_path).unwrap(); |
There was a problem hiding this comment.
I would just add a small comment noting this is useful for migration purposes.
| .unwrap_or_default(), | ||
| ); | ||
|
|
||
| let st_arg_token = " expression to operate on. Can be a constant, column, or function, and any combination of operators."; |
There was a problem hiding this comment.
Perhaps this could be extracted to a constant and that used instead of having text copies of the string in 2 places.
| // | ||
| // let file_path = format!("{}.txt", name); | ||
| // if std::path::Path::new(&file_path).exists() { | ||
| // std::fs::remove_file(&file_path).unwrap(); |
There was a problem hiding this comment.
I agree a comment explaining what this is used for would be most helpful
| @@ -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 { | |||
There was a problem hiding this comment.
Maybe it would also help helpful here to note this is to help migration to doc comment attributes
Which issue does this PR close?
Closes #.
Rationale for this change
What changes are included in this PR?
Are these changes tested?
Are there any user-facing changes?