DOC Improve documentation of safe_mask (scikit-learn#34508)

akshitasure12 · web-flow · commit 25088e0aa006 · 2026-07-18T09:37:10.000Z
diff --git a/sklearn/utils/_mask.py b/sklearn/utils/_mask.py
@@ -76,7 +76,7 @@ def _get_mask(X, value_to_mask):
     prefer_skip_nested_validation=True,
 )
 def safe_mask(X, mask):
-    """Return a mask which is safe to use on X.
+    """Return an indexing mask compatible with X.
 
     Parameters
     ----------

Original file line number	Diff line number	Diff line change
`@@ -76,7 +76,7 @@ def _get_mask(X, value_to_mask):`
`76`	`76`	`prefer_skip_nested_validation=True,`
`77`	`77`	`)`
`78`	`78`	`def safe_mask(X, mask):`
`79`		`- """Return a mask which is safe to use on X.`
	`79`	`+ """Return an indexing mask compatible with X.`
`80`	`80`
`81`	`81`	`Parameters`
`82`	`82`	`----------`