Improve comments around attribute migration effect

WordPress · Sep 7, 2022 · ed8aa33 · ed8aa33
1 parent 9df8813
commit ed8aa33
Showing 1 changed file with 3 additions and 2 deletions.
diff --git a/packages/block-library/src/navigation/edit/index.js b/packages/block-library/src/navigation/edit/index.js
@@ -303,8 +303,9 @@ function Navigation( {
 	const isEntityAvailable =
 		! isNavigationMenuMissing && isNavigationMenuResolved;
 
-	// Migrate numerical ID-based ref to
-	// string slug-based ref.
+	// Migrate the numerical ID-based ref attribute to the
+	// string-based slug attribute. This action soft-deprecates
+	// usage of the ref attribute in favour of the slug attribute.
 	useEffect( () => {
 		if ( isEntityAvailable && isNumeric( ref ) ) {
 			setRef( navigationMenu?.slug );