Skip to content

Commit d679b3b

Browse files
authored
Fix an out of date comment for snapshot_physical_expr (#18498)
## Which issue does this PR close? - Closes #18497 ## Rationale for this change Better docs ## What changes are included in this PR? Docs clarifications ## Are these changes tested? N/A ## Are there any user-facing changes? No
1 parent 32d2618 commit d679b3b

File tree

1 file changed

+2
-3
lines changed

1 file changed

+2
-3
lines changed

datafusion/physical-expr-common/src/physical_expr.rs

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -565,9 +565,8 @@ pub fn fmt_sql(expr: &dyn PhysicalExpr) -> impl Display + '_ {
565565
///
566566
/// # Returns
567567
///
568-
/// Returns an `Option<Arc<dyn PhysicalExpr>>` which is the snapshot of the
569-
/// `PhysicalExpr` if it is dynamic. If the `PhysicalExpr` does not have
570-
/// any dynamic references or state, it returns `None`.
568+
/// Returns a snapshot of the `PhysicalExpr` if it is dynamic, otherwise
569+
/// returns itself.
571570
pub fn snapshot_physical_expr(
572571
expr: Arc<dyn PhysicalExpr>,
573572
) -> Result<Arc<dyn PhysicalExpr>> {

0 commit comments

Comments
 (0)