Skip to content

[mlir] [docs] Minor documentation fix in mlir-reduce docs #142479

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.

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

Closed
wants to merge 1 commit into from

Conversation

snarang181
Copy link
Contributor

Fixes #142460

@snarang181 snarang181 marked this pull request as ready for review June 2, 2025 20:27
@llvmbot llvmbot added the mlir label Jun 2, 2025
@llvmbot
Copy link
Member

llvmbot commented Jun 2, 2025

@llvm/pr-subscribers-mlir

Author: Samarth Narang (snarang181)

Changes

Fixes #142460


Full diff: https://github.com/llvm/llvm-project/pull/142479.diff

1 Files Affected:

  • (modified) mlir/docs/Tools/mlir-reduce.md (+1-1)
diff --git a/mlir/docs/Tools/mlir-reduce.md b/mlir/docs/Tools/mlir-reduce.md
index b60cdd799ba0c..224013899b440 100644
--- a/mlir/docs/Tools/mlir-reduce.md
+++ b/mlir/docs/Tools/mlir-reduce.md
@@ -31,7 +31,7 @@ results and different time complexity. You can run as
 As mentioned, you need to provide a command to `mlir-reduce` which identifies
 cases you're interested in. For each intermediate output generated during
 reduction, `mlir-reduce` will run the command over the it, the script should
-returns 1 for interesting case, 0 otherwise. The sample script,
+returns 0 for an interesting case, 1 otherwise. The sample script,
 
 ```shell
 mlir-opt -convert-vector-to-spirv $1 | grep "failed to materialize"

@snarang181
Copy link
Contributor Author

snarang181 commented Jun 2, 2025

@qcolombet -- requesting your review here.

@@ -31,7 +31,7 @@ results and different time complexity. You can run as
As mentioned, you need to provide a command to `mlir-reduce` which identifies
cases you're interested in. For each intermediate output generated during
reduction, `mlir-reduce` will run the command over the it, the script should
returns 1 for interesting case, 0 otherwise. The sample script,
returns 0 for an interesting case, 1 otherwise. The sample script,
Copy link
Collaborator

@joker-eph joker-eph Jun 4, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I don't quite get the change, can you elaborate? The existing sentence seems correct with respect to the code sample below.

@snarang181 snarang181 closed this Jun 6, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

MLIR Reduce docs incorrect
3 participants