Skip to content

Migrate documentation for all string functions from scalar_functions.md to code #12775

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
alamb merged 8 commits into from
Oct 7, 2024
Merged

Migrate documentation for all string functions from scalar_functions.md to code #12775

Changes from 1 commit
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
53a6a67
Added documentation for string and unicode functions.
Omega359 Oct 5, 2024
9db4c09
Fixed issues with aliases.
Omega359 Oct 5, 2024
328b63a
Cargo fmt.
Omega359 Oct 5, 2024
b46a0c0
Minor doc fixes.
Omega359 Oct 6, 2024
e42527d
Merge branch 'apache:main' into feature/string_docs
Omega359 Oct 6, 2024
b3ae373
Merge remote-tracking branch 'apache/main' into feature/string_docs
alamb Oct 7, 2024
24523ea
Update docs for var_pop/samp
alamb Oct 7, 2024
aea9a55
Merge remote-tracking branch 'apache/main' into feature/string_docs
alamb Oct 7, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
Fixed issues with aliases.
  • Loading branch information
@Omega359
Omega359 committed Oct 5, 2024
commit 9db4c091e24b2694070dfa8b8e02beb7987be0d5
9 changes: 5 additions & 4 deletions datafusion/core/src/bin/print_functions_docs.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -130,13 +130,14 @@ fn print_docs(
.find(|f| f.get_name() == name || f.get_aliases().contains(&name))
.unwrap();

let name = f.get_name();
let aliases = f.get_aliases();
let documentation = f.get_documentation();

// if this name is an alias we need to display what it's an alias of
if aliases.contains(&name) {
let _ = write!(docs, "_Alias of [{name}](#{name})._");
let fname = f.get_name();
let _ = writeln!(docs, r#"### `{name}`"#);
let _ = writeln!(docs, "_Alias of [{fname}](#{fname})._");
continue;
}

Expand Down Expand Up @@ -183,10 +184,10 @@ fn print_docs(

// next, aliases
if !f.get_aliases().is_empty() {
let _ = write!(docs, "#### Aliases");
let _ = writeln!(docs, "#### Aliases");

for alias in f.get_aliases() {
let _ = writeln!(docs, "- {alias}");
let _ = writeln!(docs, "- {}", alias.replace("_", r#"\_"#));
}
}

Expand Down