Skip to content

Apache DataFusion SQL Query Engine

fix: indentation for markdown block comments in docstrings (#22409)

Ariel Miculas-Trifa8f03fdae5b2
diff --git a/datafusion/datasource/src/file_scan_config/sort_pushdown.rs b/datafusion/datasource/src/file_scan_config/sort_pushdown.rs
index af08ed71b9..ece84015a7 100644
--- a/datafusion/datasource/src/file_scan_config/sort_pushdown.rs
+++ b/datafusion/datasource/src/file_scan_config/sort_pushdown.rs
@@ -490,7 +490,7 @@ pub(crate) fn validate_orderings(
/// file is scanned, the same values for A, B and C can be repeated in
/// the same sorted stream
///
-///```text
+/// ```text
/// ┏ ━ ━ ━ ━ ━ ━ ━ ━ ━ ━ ━ ━ ━ ━ ━ ━ ━ ━ ━ ━ ━ ━
/// ┌ ─ ─ ─ ─ ─ ─ ─ ─ ─ ┐ ┌ ─ ─ ─ ─ ─ ─ ─ ─ ─ ┃
/// ┃ ┌───────────────┐ ┌──────────────┐ │
diff --git a/datafusion/doc/src/lib.rs b/datafusion/doc/src/lib.rs
index 591a5a62f3..11b63ff661 100644
--- a/datafusion/doc/src/lib.rs
+++ b/datafusion/doc/src/lib.rs
@@ -281,7 +281,7 @@ impl DocumentationBuilder {
///
/// The argument is rendered like below if None is passed through:
///
- /// ```text
+ /// ```text
/// <arg_name>:
/// The expression to operate on. Can be a constant, column, or function, and any combination of operators.
/// ```
diff --git a/datafusion/expr/src/expr.rs b/datafusion/expr/src/expr.rs
index e652a29f48..71d3057575 100644
--- a/datafusion/expr/src/expr.rs
+++ b/datafusion/expr/src/expr.rs
@@ -92,7 +92,7 @@ impl From<sqlparser::ast::NullTreatment> for NullTreatment {
///
/// For example the expression `A + 1` will be represented as
///
-///```text
+/// ```text
/// BinaryExpr {
/// left: Expr::Column("A"),
/// op: Operator::Plus,
@@ -265,7 +265,7 @@ impl From<sqlparser::ast::NullTreatment> for NullTreatment {
///
/// [`ExplainFormat::Tree`]: crate::logical_plan::ExplainFormat::Tree
///
-///```
+/// ```
/// # use datafusion_expr::{lit, col};
/// let expr = col("c1") + lit(42);
/// assert_eq!(format!("{}", expr.human_display()), "c1 + 42");
@@ -301,7 +301,7 @@ impl From<sqlparser::ast::NullTreatment> for NullTreatment {
/// Rewrite an expression, replacing references to column "a" in an
/// to the literal `42`:
///
-/// ```
+/// ```
/// # use datafusion_common::tree_node::{Transformed, TreeNode};
/// # use datafusion_expr::{col, Expr, lit};
/// // expression a = 5 AND b = 6
diff --git a/datafusion/physical-plan/src/aggregates/row_hash.rs b/datafusion/physical-plan/src/aggregates/row_hash.rs
index b4ac7d0605..1164fb37b3 100644
--- a/datafusion/physical-plan/src/aggregates/row_hash.rs
+++ b/datafusion/physical-plan/src/aggregates/row_hash.rs
@@ -262,7 +262,7 @@ enum OutOfMemoryMode {
///
/// group_values accumulators
///
-/// ```
+/// ```
///
/// For example, given a query like `COUNT(x), SUM(y) ... GROUP BY z`,
/// [`group_values`] will store the distinct values of `z`. There will
diff --git a/datafusion/physical-plan/src/display.rs b/datafusion/physical-plan/src/display.rs
index f7c6de3fc5..8ad1f60651 100644
--- a/datafusion/physical-plan/src/display.rs
+++ b/datafusion/physical-plan/src/display.rs
@@ -75,7 +75,7 @@ pub enum DisplayFormatType {
/// │ partition_sizes: [1] │
/// │ Parquet │
/// └───────────────────────────┘
- /// ```
+ /// ```
TreeRender,
}
diff --git a/datafusion/physical-plan/src/repartition/mod.rs b/datafusion/physical-plan/src/repartition/mod.rs
index 465ca4a99e..a6363378ed 100644
--- a/datafusion/physical-plan/src/repartition/mod.rs
+++ b/datafusion/physical-plan/src/repartition/mod.rs
@@ -916,7 +916,7 @@ impl BatchPartitioner {
/// used to get 3 even streams of `RecordBatch`es
///
///
-///```text
+/// ```text
/// ▲ ▲ ▲
/// │ │ │
/// │ │ │