Skip to content

Commit a8f03fd

Browse files
fix: indentation for markdown block comments in docstrings (#22409)
## Which issue does this PR close? Minor enough that I didn't open an issue for it. ## Rationale for this change There must be some issue in vim's syntax highlighting, possibly in https://github.com/rust-lang/rust.vim, but these minor inconsistencies break the sytax highlighting. ## What changes are included in this PR? <!-- There is no need to duplicate the description in the issue here but it is sometimes worth providing a summary of the individual changes in this PR. --> ## Are these changes tested? Before: <img width="1728" height="1117" alt="Screenshot 2026-05-21 at 10 15 50" src="https://github.com/user-attachments/assets/d74fb1e0-b894-49f7-8847-17be12578477" /> After: <img width="1728" height="1117" alt="Screenshot 2026-05-21 at 10 16 06" src="https://github.com/user-attachments/assets/14e291de-4e84-4385-8b84-0a553c64138e" /> ## Are there any user-facing changes? No
1 parent 077f08a commit a8f03fd

6 files changed

Lines changed: 8 additions & 8 deletions

File tree

‎datafusion/datasource/src/file_scan_config/sort_pushdown.rs‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -490,7 +490,7 @@ pub(crate) fn validate_orderings(
490490
/// file is scanned, the same values for A, B and C can be repeated in
491491
/// the same sorted stream
492492
///
493-
///```text
493+
/// ```text
494494
/// ┏ ━ ━ ━ ━ ━ ━ ━ ━ ━ ━ ━ ━ ━ ━ ━ ━ ━ ━ ━ ━ ━ ━
495495
/// ┌ ─ ─ ─ ─ ─ ─ ─ ─ ─ ┐ ┌ ─ ─ ─ ─ ─ ─ ─ ─ ─ ┃
496496
/// ┃ ┌───────────────┐ ┌──────────────┐ │

‎datafusion/doc/src/lib.rs‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -281,7 +281,7 @@ impl DocumentationBuilder {
281281
///
282282
/// The argument is rendered like below if None is passed through:
283283
///
284-
/// ```text
284+
/// ```text
285285
/// <arg_name>:
286286
/// The expression to operate on. Can be a constant, column, or function, and any combination of operators.
287287
/// ```

‎datafusion/expr/src/expr.rs‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -92,7 +92,7 @@ impl From<sqlparser::ast::NullTreatment> for NullTreatment {
9292
///
9393
/// For example the expression `A + 1` will be represented as
9494
///
95-
///```text
95+
/// ```text
9696
/// BinaryExpr {
9797
/// left: Expr::Column("A"),
9898
/// op: Operator::Plus,
@@ -265,7 +265,7 @@ impl From<sqlparser::ast::NullTreatment> for NullTreatment {
265265
///
266266
/// [`ExplainFormat::Tree`]: crate::logical_plan::ExplainFormat::Tree
267267
///
268-
///```
268+
/// ```
269269
/// # use datafusion_expr::{lit, col};
270270
/// let expr = col("c1") + lit(42);
271271
/// assert_eq!(format!("{}", expr.human_display()), "c1 + 42");
@@ -301,7 +301,7 @@ impl From<sqlparser::ast::NullTreatment> for NullTreatment {
301301
/// Rewrite an expression, replacing references to column "a" in an
302302
/// to the literal `42`:
303303
///
304-
/// ```
304+
/// ```
305305
/// # use datafusion_common::tree_node::{Transformed, TreeNode};
306306
/// # use datafusion_expr::{col, Expr, lit};
307307
/// // expression a = 5 AND b = 6

‎datafusion/physical-plan/src/aggregates/row_hash.rs‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -262,7 +262,7 @@ enum OutOfMemoryMode {
262262
///
263263
/// group_values accumulators
264264
///
265-
/// ```
265+
/// ```
266266
///
267267
/// For example, given a query like `COUNT(x), SUM(y) ... GROUP BY z`,
268268
/// [`group_values`] will store the distinct values of `z`. There will

‎datafusion/physical-plan/src/display.rs‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -75,7 +75,7 @@ pub enum DisplayFormatType {
7575
/// │ partition_sizes: [1] │
7676
/// │ Parquet │
7777
/// └───────────────────────────┘
78-
/// ```
78+
/// ```
7979
TreeRender,
8080
}
8181

‎datafusion/physical-plan/src/repartition/mod.rs‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -916,7 +916,7 @@ impl BatchPartitioner {
916916
/// used to get 3 even streams of `RecordBatch`es
917917
///
918918
///
919-
///```text
919+
/// ```text
920920
/// ▲ ▲ ▲
921921
/// │ │ │
922922
/// │ │ │

0 commit comments

Comments
 (0)